summaryrefslogtreecommitdiff
path: root/doc/walkthrough.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2010-10-27 14:33:44 -0400
committerGravatar Joey Hess <joey@kitenet.net>2010-10-27 14:33:44 -0400
commit563484e1354878df4a6877e4506af0d70e41b13e (patch)
tree119b65ec7fa76f1f6a72c25739f48bce1a58c146 /doc/walkthrough.mdwn
parent3281a1cb19e25f964ca9b91877a194fcb216ca5d (diff)
pre-commit hook
Diffstat (limited to 'doc/walkthrough.mdwn')
-rw-r--r--doc/walkthrough.mdwn18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/walkthrough.mdwn b/doc/walkthrough.mdwn
index ce68a77f7..b49a00f19 100644
--- a/doc/walkthrough.mdwn
+++ b/doc/walkthrough.mdwn
@@ -43,23 +43,25 @@ if you are using a centralized bare repository.
add debian.iso ok
# git commit -a -m added
-Notice you commit at the end, this checks in git-annex's record of the
-files but not their actual, large, content.
+When you add a file to the annex and commit it, only a symlink to
+the annexed content is committed. The content itself is stored in
+git-annex's backend.
## renaming files
# cd ~/annex
# git mv big_file my_cool_big_file
# mkdir iso
- # git mv debian.iso iso
- # git annex fix .
- fix iso/debian.iso ok
+ # git mv debian.iso iso/
# git commit -m moved
You can use any normal git operations to move files around, or even
-make copies or delete them. `git-annex fix` needs to be run if a file
-is moved into a different directory, in order to fix up the symlink
-pointing to the file's content.
+make copies or delete them.
+
+Notice that, since annexed files are represented by symlinks,
+the symlink will break when the file is moved into a subdirectory.
+But, git-annex will fix this up for you when you commit --
+it has a pre-commit hook that watches for and corrects broken symlinks.
## getting file content