summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-08-04 14:37:43 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-08-04 14:37:43 -0400
commit1f78c03012fa46bd0e4b0c7af9b70df872f35b0d (patch)
treeed2991ad87698660137192b5844d964ae5302d57 /doc
parent76bc6f4b653a9dc94709fc3ee511cc877c487ee1 (diff)
improve docs
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-proxy.mdwn14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/git-annex-proxy.mdwn b/doc/git-annex-proxy.mdwn
index 814cc7676..2744b1134 100644
--- a/doc/git-annex-proxy.mdwn
+++ b/doc/git-annex-proxy.mdwn
@@ -31,13 +31,13 @@ stage the changes in the index, and then proxy a commit:
git annex add myfile
git annex proxy -- git commit myfile -m foo
-Note that git annex proxy cannot be usefully used with git commands that
-look at work tree files. For example, it doesn't make sense to proxy "git
-add". This is because the temporary work tree used for proxying doesn't
-contain all the files that are in the real work tree. However, any unstaged
-work tree files are hard linked (or copied) into the temporary work tree,
-so that a command like git revert, that will fail if the change it's
-making overwrites work tree files, will behave the same when proxied.
+The temporary work tree that the git command is run in is set up by
+checking out all files that are in the index, and copying (or hard linking)
+any unstaged files from the real work tree. Since the git command is run
+using this temporary work tree, it won't see eg, local modifications to
+files. So, it probably is not useful to proxy a command like "git add".
+However, you can use the proxy with any git command you like, as long as
+you think about how it will interact with the temporary work tree.
# SEE ALSO