update docs for sync --content

This commit is contained in:
Joey Hess 2014-02-02 16:21:42 -04:00
parent 6d5efe34dc
commit ba6cba97d2
2 changed files with 15 additions and 9 deletions

View file

@ -36,3 +36,9 @@ The workflow for using `git annex sync` is simple:
* Run `git annex sync` to save the changes. * Run `git annex sync` to save the changes.
* Next time you're working on a different clone of that repository, * Next time you're working on a different clone of that repository,
run `git annex sync` to update it. run `git annex sync` to update it.
Note that by default, `git annex sync` only synchronises the git
repositories, but does not transfer the content of annexed files. If you
want to fully synchronise two repositories content,
you can use `git annex sync --content`. You can also configure
[[preferred_content]] settings to make only some content be synced.

View file

@ -15,13 +15,13 @@ Let's look at what the sync command does in more detail:
push laptop push laptop
ok ok
After you run sync, the repository will be updated with all changes made to After you run sync, the git repository will be updated with all changes
its remotes, and any changes in the repository will be pushed out to its made to its remotes, and any changes in the git repository will be pushed
remotes, where a sync will get them. This is especially useful when using out to its remotes, where a sync will get them. This is especially useful
git in a distributed fashion, without a when using git in a distributed fashion, without a [[central bare
[[central bare repository|tips/centralized_git_repository_tutorial]]. See repository|tips/centralized_git_repository_tutorial]]. See [[sync]] for
[[sync]] for details. details.
Note that syncing only syncs the metadata about your files that is stored By default `git annex sync` only syncs the metadata about your
in git. It does not sync the contents of files, that are managed by files that is stored in git. It does not sync the contents of files, that
git-annex. are managed by git-annex. To do that, you can use `git annex sync --content`