summaryrefslogtreecommitdiff
path: root/doc/git-annex-sync.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-06-16 16:50:03 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-06-16 16:50:03 -0400
commit712deee42b122f0ec07866e6bd7770343cee971c (patch)
tree4eb2525edc3cf17d2f6710c7ce52eb28d423f28b /doc/git-annex-sync.mdwn
parentc9d9fca2ed950b32be992d5ac2a055c8246f52a5 (diff)
sync: Add support for --all and --unused.
Diffstat (limited to 'doc/git-annex-sync.mdwn')
-rw-r--r--doc/git-annex-sync.mdwn39
1 files changed, 26 insertions, 13 deletions
diff --git a/doc/git-annex-sync.mdwn b/doc/git-annex-sync.mdwn
index 1659dfb8b..2d81d44de 100644
--- a/doc/git-annex-sync.mdwn
+++ b/doc/git-annex-sync.mdwn
@@ -21,6 +21,9 @@ those branches on the remote repositories. You can use standard git
commands to do each of those steps by hand, or if you don't want to
worry about the details, you can use sync.
+The content of annexed objects is not synced by default, but the --content
+option (see below) can make that also be synchronized.
+
Merge conflicts are automatically handled by sync. When two conflicting
versions of a file have been committed, both will be added to the tree,
under different filenames. For example, file "foo" would be replaced
@@ -31,9 +34,12 @@ tree with changes made to the local repository. However, those changes
are pushed to the remote, so they can be merged into its working tree
by running "git annex sync" on the remote.
-
# OPTIONS
+* `--message=msg`
+
+ Use this option to specify a commit message.
+
* `--fast`
Only sync with the remotes with the lowest annex-cost value configured.
@@ -41,20 +47,29 @@ by running "git annex sync" on the remote.
* `--content`
Normally, syncing does not transfer the contents of annexed files.
- This option causes the file contents to also be uploaded and downloaded
- as necessary.
+ This 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 that the local repository
- does not yet have, and then copies each file to every remote that it is
- syncing with. This behavior can be overridden by configuring the preferred
- content of a repository. See [[git-annex-preferred-content]](1).
+ By default, 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
+ of a repository. See [[git-annex-preferred-content]](1).
- To make two repositories have the same set of files, you should use
- [[git-annex-mirror]](1) instead of this flag.
+* `--all`
-* `--message=msg`
+ This option, when combined with `--content`, makes all available versions
+ of all files be synced, when preferred content settings allow.
- Use this option to specify a commit message.
+ Note that preferred content settings that use `include=` or `exclude=`
+ will only match the version of files currently in the work tree, but not
+ past versions of files.
+
+* `--unused`
+
+ This option, when combined with `--content`, makes files
+ found by last run of git-annex unused be synced, when preferred content
+ settings allow.
# SEE ALSO
@@ -62,8 +77,6 @@ by running "git annex sync" on the remote.
[[git-annex-preferred-content]](1)
-[[git-annex-mirror]](1)
-
# AUTHOR
Joey Hess <id@joeyh.name>