aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-04-05 13:04:02 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-04-05 13:22:35 -0400
commit2d8cbcafa66a317fcb3d571cd8bf45962d651998 (patch)
tree9c39bb0de77d3570e403d29acc99ac04ead4de89 /doc/git-annex.mdwn
parentd3f440e599ee0271a7a6e8c441e5d00b3c9548e3 (diff)
Added remote.<name>.annex-push and remote.<name>.annex-pull
The former can be useful to make remotes that don't get fully synced with local changes, which comes up in a lot of situations. The latter was mostly added for symmetry, but could be useful (though less likely to be). Implementing `remote.<name>.annex-pull` was a bit tricky, as there's no one place where git-annex pulls/fetches from remotes. I audited all instances of "fetch" and "pull". A few cases were left not checking this config: * Git.Repair can try to pull missing refs from a remote, and if the local repo is corrupted, that seems a reasonable thing to do even though the config would normally prevent it. * Assistant.WebApp.Gpg and Remote.Gcrypt and Remote.Git do fetches as part of the setup process of a remote. The config would probably not be set then, and having the setup fail seems worse than honoring it if it is already set. I have not prevented all the code that does a "merge" from merging branches from remotes with remote.<name>.annex-pull=false. That could perhaps be done, but it would need a way to map from branch name to remote name, and the way refspecs work makes that hard to get really correct. So if the user fetches manually, the git-annex branch will get merged, for example. Anther way of looking at/justifying this is that the setting is called "annex-pull", not "annex-merge". This commit was supported by the NSF-funded DataLad project.
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 07b8b19e1..2bebd9f49 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -1156,7 +1156,18 @@ Here are all the supported configuration settings.
* `remote.<name>.annex-sync`
If set to `false`, prevents git-annex sync (and the git-annex assistant)
- from syncing with this remote.
+ from syncing with this remote by default. However, `git annex sync <name>`
+ can still be used to sync with the remote.
+
+* `remote.<name>.annex-pull`
+
+ If set to `false`, prevents git-annex sync (and the git-annex assistant
+ etc) from ever pulling (or fetching) from the remote.
+
+* `remote.<name>.annex-push`
+
+ If set to `false`, prevents git-annex sync (and the git-annex assistant
+ etc) from ever pushing to the remote.
* `remote.<name>.annex-readonly`