From ba6cba97d2a4cd69fbd4a3ccf8df8f337a577382 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sun, 2 Feb 2014 16:21:42 -0400 Subject: [PATCH] update docs for sync --content --- doc/sync.mdwn | 6 ++++++ doc/walkthrough/syncing.mdwn | 18 +++++++++--------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/doc/sync.mdwn b/doc/sync.mdwn index 37b2b1b459..0250d2fef0 100644 --- a/doc/sync.mdwn +++ b/doc/sync.mdwn @@ -36,3 +36,9 @@ The workflow for using `git annex sync` is simple: * Run `git annex sync` to save the changes. * Next time you're working on a different clone of that repository, 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. diff --git a/doc/walkthrough/syncing.mdwn b/doc/walkthrough/syncing.mdwn index 0c8d525597..57fe47db05 100644 --- a/doc/walkthrough/syncing.mdwn +++ b/doc/walkthrough/syncing.mdwn @@ -15,13 +15,13 @@ Let's look at what the sync command does in more detail: push laptop ok -After you run sync, the repository will be updated with all changes made to -its remotes, and any changes in the repository will be pushed out to its -remotes, where a sync will get them. This is especially useful when using -git in a distributed fashion, without a -[[central bare repository|tips/centralized_git_repository_tutorial]]. See -[[sync]] for details. +After you run sync, the git repository will be updated with all changes +made to its remotes, and any changes in the git repository will be pushed +out to its remotes, where a sync will get them. This is especially useful +when using git in a distributed fashion, without a [[central bare +repository|tips/centralized_git_repository_tutorial]]. See [[sync]] for +details. -Note that syncing only syncs the metadata about your files that is stored -in git. It does not sync the contents of files, that are managed by -git-annex. +By default `git annex sync` only syncs the metadata about your +files that is stored in git. It does not sync the contents of files, that +are managed by git-annex. To do that, you can use `git annex sync --content`