improve docs

This commit is contained in:
Joey Hess 2015-08-04 14:37:43 -04:00
parent 6c15cdfcb8
commit 2abd248cf2

View file

@ -31,13 +31,13 @@ stage the changes in the index, and then proxy a commit:
git annex add myfile git annex add myfile
git annex proxy -- git commit myfile -m foo git annex proxy -- git commit myfile -m foo
Note that git annex proxy cannot be usefully used with git commands that The temporary work tree that the git command is run in is set up by
look at work tree files. For example, it doesn't make sense to proxy "git checking out all files that are in the index, and copying (or hard linking)
add". This is because the temporary work tree used for proxying doesn't any unstaged files from the real work tree. Since the git command is run
contain all the files that are in the real work tree. However, any unstaged using this temporary work tree, it won't see eg, local modifications to
work tree files are hard linked (or copied) into the temporary work tree, files. So, it probably is not useful to proxy a command like "git add".
so that a command like git revert, that will fail if the change it's However, you can use the proxy with any git command you like, as long as
making overwrites work tree files, will behave the same when proxied. you think about how it will interact with the temporary work tree.
# SEE ALSO # SEE ALSO