NAME
git-annex sync - synchronize local repository with remotes
SYNOPSIS
git annex sync [remote ...]
DESCRIPTION
This command synchronizes the local repository with its remotes.
This command first commits any local changes to files that have previously been added to the repository. Then it does the equivilant of git-annex-pull(1) followed by git-annex-push(1).
However, unlike those commands, this command does not transfer annexed content by default. That will change in a future version of git-annex, when syncing with repositories that have preferred content configured.
OPTIONS
--content,--no-content,-gThe --content option causes the content of annexed files to also be pulled and pushed.
The --no-content and -g options cause the content of annexed files to not be pulled and pushed.
The
annex.synccontentconfiguration can be set to true to make--contentbe enabled by default.--content-of=path-C pathThis option causes the content of annexed files in the given path to also be pulled and pushed.
This option can be repeated multiple times with different paths.
Note that this option does not prevent exporting other files to an "exporttree=yes" remote.
--commit,--no-commitA commit is done by default (unless
annex.autocommitis set to false).Use --no-commit to avoid committing local changes.
--message=msg-m msgUse this option to specify a commit message.
If multiple -m options are given, their values are concatenated as separate paragraphs.
--pull,--no-pullUse this option to disable pulling.
When
remote.<name>.annex-syncis set to false, pulling is disabled for that remote, and using--pullwill not enable it.--push,--no-pushUse this option to disable pushing.
When
remote.<name>.annex-syncis set to false, pushing is disabled for that remote, and using--pushwill not enable it.Also all options supported by git-annex-pull(1) and git-annex-push(1) can be used.
Also the git-annex-common-options(1) can be used.
SEE ALSO
git-annex(1)
AUTHOR
Joey Hess id@joeyh.name
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
When a push would result in a non-fast-forward merge, git-annex-sync currently fails. Maybe instead, pull and retry pushing? This happens in the context of several processes trying to push to the same git-annex repo.
Also, the docs mention synced/master, but it's synced/current-branch.
git-annex sync pulls before pushing. If another push occurs at the same time, the push might fail, but retrying the pull will not avoid that same situation occurring again. I don't think it makes sense for git-annex sync to retry an arbitrary number of times.
With approptiate locking to prevent concurrency problems. As is the case extensively throughout git-annex, although users seem to keep expecting that to not be the case no matter how many times I assure them it is.
I'm a bit confused by what is mentioned in this page:
but just above it's explained that by default Git does not allow to push to remote master:
In addition the page https://git-annex.branchable.com/sync/ doesn't mention that the remote master branch is directly synchronized:
So I was wondering about the correctness of the first cited sentence.
The push to remote master will typically fail in a non-bare repository (it is possible to configure one to allow it). The push to synced/master will then succeed. Then when sync is later run in that repository, it will merge synced/master into master.