mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

clarify description of synced/ branches

Browse source
This commit is contained in:
Joey Hess 2020-02-18 12:42:44 -04:00
parent 06f6eb7a70
commit f1a1669224
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/git-annex-sync.mdwn
View file

@ -12,7 +12,7 @@ This command synchronizes the local repository with its remotes.
The sync process involves first committing any local changes to files
that have previously been added to the repository,
then fetching and merging the `synced/master` and the `git-annex` branch
then fetching and merging the current branch and the `git-annex` branch
from the remote repositories, and finally pushing the changes back to
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
@ -21,11 +21,18 @@ 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.
Note that syncing with a remote will not normally update the remote's working
tree with changes made to the local repository. (Unless it's configured
with receive.denyCurrentBranch=updateInstead.) 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.
When using git-annex, often remotes are not bare repositories, because
it's helpful to add remotes for nearby machines that you want
to access the same annexed content. Syncing with a non-bare remote will
not normally update the remote's current branch with changes from the local
repository. (Unless the remote is configured with
receive.denyCurrentBranch=updateInstead.)
To make working with such non-bare remotes easier, sync pushes not only
local `master` to remote `master`, but also to remote `synced/master` (and
similar with other branches). When `git-annex sync` is later run on the
remote, it will merge the `synced/` branches that the repository has
received.
# OPTIONS
@ -41,7 +48,8 @@ by running "git annex sync" on the remote.
* `--only-annex` `-a`, `--not-only-annex`
Only get sync the git-annex branch and annexed content with remotes.
Only sync the git-annex branch and annexed content with remotes,
not other git branches.
This avoids pulling and pushing other branches, and it avoids committing
any local changes. It's up to you to use regular git commands to do that.
@ -50,6 +58,9 @@ by running "git annex sync" on the remote.
this be the default behavior of `git-annex sync`. To override such
a setting, use `--not-only-annex`.
When this is combined with --no-content, only the git-annex branch
will be synced.
* `--commit`, `--no-commit`
A commit is done by default (unless `annex.autocommit` is set to false).