summaryrefslogtreecommitdiff
path: root/doc/git-annex.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/git-annex.mdwn
parent3281a1cb19e25f964ca9b91877a194fcb216ca5d (diff)
pre-commit hook
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 417ff7e58..f7bb64988 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -107,9 +107,13 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
Fixes up symlinks that have become broken to again point to annexed content.
This is useful to run if you have been moving the symlinks around.
- You do not normally need to run this by hand since `git-annex init`
- installs a pre-commit hook that automatically fixes up symlinks when
- they are committed.
+* pre-commit [path ...]
+
+ Fixes up symlinks that are staged as part of a commit, to ensure they
+ point to annexed content.
+
+ This is meant to be called from git's pre-commit hook. `git annex init`
+ automatically creates a pre-commit hook using this.
* fromkey file
@@ -202,7 +206,7 @@ decscriptions. You may edit it.
`.git-annex/*.log` is where git-annex records its content tracking
information. These files should be committed to git.
-`.git-annex/.gitattributes` is configured to use git's union merge driver
+`.gitattributes` is configured to use git's union merge driver
to avoid conflicts when merging files in the `.git-annex` directory.
# AUTHOR