aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2024-05-20 09:47:58 +0200
committerJonas Smedegaard <dr@jones.dk>2024-05-20 09:47:58 +0200
commitcbd4703eb81b583d9a9e91227067368491b88aae (patch)
treef4ae6ad63cbd7fd27ed70fc07b383567701db1ad
parentb03347f7e43c3c312e15b3dae1ff342f5a6140ad (diff)
move non-initial parts of SETUP section Clone to new USE section Sync
-rw-r--r--SETUP.md27
-rw-r--r--USE.md26
2 files changed, 28 insertions, 25 deletions
diff --git a/SETUP.md b/SETUP.md
index 09df9cc..7097c90 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -42,20 +42,20 @@ add e.g. the following to file `.gitattributes`:
*.svg annex.largefiles=nothing
```
-Finally (save)[#Save] all content:
+Finally, save all content:
```shell
git annex add .
git commit -m "Initial commit"
```
-(final `git commit` is implied by [`git annex sync` or `git annex move`](#clone))
+(final `git commit` is implied by a later `git annex sync` or `git annex move`)
## Clone
To collaborate on a shared git repository,
-first create a local clone from the shared location,
+create a local clone from the shared location,
and tell git-annex to use it:
```shell
@@ -63,27 +63,6 @@ git clone git://[[!template id=githost]]/example
git annex init
```
-Then from time to time syncronize,
-ensuring that all content exists both locally and remotely:
-
-```shell
-git annex sync --content --all
-```
-
-Alternatively (e.g. on slow/expensive network),
-syncronize only metadata and only with nearest clones:
-
-```shell
-git annex sync
-```
-
-Alternatively (e.g. on small host),
-push the content to only be remote without keeping a local copy:
-
-```shell
-git annex move .
-```
-
### Publish
diff --git a/USE.md b/USE.md
index 7b7cd45..675659b 100644
--- a/USE.md
+++ b/USE.md
@@ -38,7 +38,31 @@ git annex add baz
git commit -m "Update foo bar, and add baz."
```
-(final `git commit` is implied by [`git annex sync` or `git annex move`](#clone))
+(final `git commit` is implied by [`git annex sync` or `git annex move`](#sync))
+
+
+## Sync
+
+To align a git-annex repository with subscribed annex(es),
+request a syncronization:
+
+```shell
+git annex sync --content --all
+```
+
+Alternatively (e.g. on slow/expensive network),
+syncronize only metadata and only with nearest clones:
+
+```shell
+git annex sync
+```
+
+Alternatively (e.g. on small host),
+push the content to only be remote without keeping a local copy:
+
+```shell
+git annex move .
+```
## Access