summaryrefslogtreecommitdiff
path: root/doc/git-annex-sync.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-09-13 13:15:35 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-09-13 13:15:35 -0400
commit53c30126a0e87cef22c14ea537ea1c84d4993104 (patch)
treebc523c34a3e5c0972a96decd540724ba7badbc52 /doc/git-annex-sync.mdwn
parent14cca145c4277154a5165bfe82441135309ea0e4 (diff)
sync: Add --no-commit, --no-pull, --no-push options to turn off parts of the sync process, as well as supporting --commit, --pull, --push, and --no-content options to specify the (current) default behavior.
Diffstat (limited to 'doc/git-annex-sync.mdwn')
-rw-r--r--doc/git-annex-sync.mdwn22
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/git-annex-sync.mdwn b/doc/git-annex-sync.mdwn
index b4c23f843..a380bcaf1 100644
--- a/doc/git-annex-sync.mdwn
+++ b/doc/git-annex-sync.mdwn
@@ -36,21 +36,33 @@ by running "git annex sync" on the remote.
# OPTIONS
+* `--fast`
+
+ Only sync with the remotes with the lowest annex-cost value configured.
+
+* `--commit`, `--no-commit`
+
+ A commit is done by default. Use --no-cmmit to avoid committing local changes.
+
* `--message=msg`
Use this option to specify a commit message.
-* `--fast`
+* `--pull`, `--no-pull`
- Only sync with the remotes with the lowest annex-cost value configured.
+ By default, git pulls from remotes. Use --no-pull to disable.
+
+* `--push`, `--no-push`
+
+ By default, git pushes to remotes. Use --no-push to disable.
-* `--content`
+* `--content`, `--no-content`
Normally, syncing does not transfer the contents of annexed files.
- This option causes the content of files in the work tree
+ The --content option causes the content of files in the work tree
to also be uploaded and downloaded as necessary.
- By default, this tries to get each annexed file in the work tree
+ Normally this tries to get each annexed file in the work tree
that the local repository does not yet have, and then copies each
file in the work tree to every remote that it is syncing with.
This behavior can be overridden by configuring the preferred content