summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2010-10-17 18:52:01 -0400
committerGravatar Joey Hess <joey@kitenet.net>2010-10-17 18:52:01 -0400
commitbb6707020d08f7509c21c1229088bb6017438caf (patch)
tree5fc472dc1fc0ca3ee5c231021b3721950c51f567
parente602238cd8cd309cea812ae85044f7d9f79be530 (diff)
update
-rw-r--r--doc/git-annex.mdwn29
1 files changed, 13 insertions, 16 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 4647eb058..d15ca4a9f 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -146,6 +146,19 @@ descriptions to help you with finding them:
e1938fee-d95b-11df-96cc-002170d25c55
git-annex: get myfile failed
+## symlink farming commit hook
+
+git-annex does use a lot of symlinks. Specicially, relative symlinks,
+that are checked into git. To allow you to move those around without
+annoyance, git-annex can run as a post-commit hook. This way, you can `git mv`
+a symlink to an annexed file, and as soon as you commit, it will be fixed
+up.
+
+`git annex init` tries to set up a post-commit hook that is itself a symlink
+back to git-annex. If you want to have your own shell script in the post-commit
+hook, just make it call `git annex` with no parameters. git-annex will detect
+when it's run from a git hook and do the necessary fixups.
+
## configuration
* `annex.uuid` -- a unique UUID for this repository
@@ -165,22 +178,6 @@ descriptions to help you with finding them:
## issues
-### symlinks
-
-If the symlink to annexed content is relative, moving it to a subdir will
-break it. But it it's absolute, moving the git repo (or mounting its drive
-elsewhere) will break it. Either:
-
-* Use relative links and need `git annex mv` to move (or post-commit
- hook that caches moves and updates links).
-* Use absolute links and need `git annex fixlinks` when location changes;
- note that would also mean that git would see the symlink targets changed
- and want to commit the change. And, other clones of the repo would
- diverge and there would be conflicts on the symlink text. Ugh.
-
-Hard links are not an option, because git would then happily commit the
-file content. Amoung other reasons..
-
### free space determination
Need a way to tell how much free space is available on the disk containing