summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 08def0d62..d7a51663f 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -120,6 +120,17 @@ subdirectories).
Use this to undo an unlock command if you don't want to modify
the files, or have made modifications you want to discard.
+* sync
+
+ Use this command when you want to synchronize the local repository
+ with its default remote (typically "origin"). The sync process involves
+ first committing all local changes, then pulling and merging any changes
+ from the remote, and finally pushing the repository's state to the remote.
+ 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.
+
+ Note that sync does not transfer any file contents from or to the remote.
+
* addurl [url ...]
Downloads each url to a file, which is added to the annex.