initial pass at doc update

This commit is contained in:
Joey Hess 2011-03-15 22:19:44 -04:00
parent 4651688290
commit 27472710c7
7 changed files with 13 additions and 16 deletions

3
debian/changelog vendored
View file

@ -1,5 +1,8 @@
git-annex (0.24) UNRELEASED; urgency=low
* Reorganized annexed object store. annex.version=2
* The setkey, fromkey, and dropkey subcommands have changed how
the key is specified. --backend is no longer used with these.
* Add Suggests on graphviz. Closes: #618039
* When adding files to the annex, the symlinks pointing at the annexed
content are made to have the same mtime as the original file.

View file

@ -234,11 +234,11 @@ Many git-annex commands will stage changes for later `git commit` by you.
This can be used to manually set up a file to link to a specified key
in the key-value backend. How you determine an existing key in the backend
varies. For the URL backend, the key is just a URL to the content.
varies. For the URL backend, the key is based on an URL to the content.
Example:
git annex fromkey --backend=URL --key=http://www.archive.org/somefile somefile
git annex fromkey --key=URL--http://www.archive.org/somefile somefile
* dropkey [key ...]
@ -248,24 +248,18 @@ Many git-annex commands will stage changes for later `git commit` by you.
This can be used to drop content for arbitrary keys, which do not need
to have a file in the git repository pointing at them.
A backend will typically need to be specified with --backend. If none
is specified, the first configured backend is used.
Example:
git annex dropkey --backend=SHA1 7da006579dd64330eb2456001fd01948430572f2
git annex dropkey --key=SHA1-s10-7da006579dd64330eb2456001fd01948430572f2
* setkey file
This plumbing-level command sets the annexed data for a key to the content of
the specified file, and then removes the file.
A backend will typically need to be specified with --backend. If none
is specified, the first configured backend is used.
Example:
git annex setkey --backend=WORM --key=1287765018:3 /tmp/file
git annex setkey --key=WORM-s3-m1287765018--file /tmp/file
# OPTIONS

View file

@ -27,7 +27,7 @@ and this symlink is what gets committed to git in the end.
add my_cool_big_file ok
[master 64cda67] changed an annexed file
2 files changed, 2 insertions(+), 1 deletions(-)
create mode 100644 .git-annex/WORM:1289672605:30:file.log
create mode 100644 .git-annex/WORM-s30-m1289672605--file.log
There is one problem with using `git commit` like this: Git wants to first
stage the entire contents of the file in its index. That can be slow for

View file

@ -9,5 +9,5 @@ makes it very easy.
move my_cool_big_file (moving to usbdrive...) ok
# git annex move video/hackity_hack_and_kaxxt.mov --from fileserver
move video/hackity_hack_and_kaxxt.mov (moving from fileserver...)
WORM:1274316523:86050597:hackity_hack_and_kax 100% 82MB 199.1KB/s 07:02
WORM-s86050597-m1274316523--hackity_hack_and_kax 100% 82MB 199.1KB/s 07:02
ok

View file

@ -12,8 +12,8 @@ eliminate it to save space.
unused (checking for unused data...)
Some annexed data is no longer pointed to by any files in the repository.
NUMBER KEY
1 WORM:1289672605:3:file
2 WORM:1289672605:14:file
1 WORM-s3-m1289672605--file
2 WORM-s14-m1289672605--file
(To see where data was previously used, try: git log --stat -S'KEY')
(To remove unwanted data: git-annex dropunused NUMBER)
ok

View file

@ -13,7 +13,7 @@ Now you can get files and they will be transferred (using `rsync` via `ssh`):
# git annex get my_cool_big_file
get my_cool_big_file (getting UUID for origin...) (copying from origin...)
WORM:1285650548:2159:my_cool_big_file 100% 2159 2.1KB/s 00:00
WORM-s2159-m1285650548--my_cool_big_file 100% 2159 2.1KB/s 00:00
ok
When you drop files, git-annex will ssh over to the remote and make

View file

@ -5,7 +5,7 @@ Another handy backend is the URL backend, which can fetch file's content
from remote URLs. Here's how to set up some files in your repository
that use this backend:
# git annex fromkey --backend=URL --key=http://www.archive.org/somefile somefile
# git annex fromkey --key=URL--http://www.archive.org/somefile somefile
fromkey somefile ok
# git commit -m "added a file from the Internet Archive"