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

improve man page wording

Browse source
This commit is contained in:
Joey Hess 2021-04-01 12:58:06 -04:00
parent 5c227b414e
commit 370e71aa73
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 27 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/bugs/sync_--content_succeeds_w__47__o_fetching_all_files/comment_4_23a16e94a0f18126caa6cb2f94131277._comment Normal file
View file

@ -0,0 +1,20 @@
[[!comment format=mdwn
username="joey"
subject="""comment 4"""
date="2021-04-01T16:36:11Z"
content="""
It would be impossible to sync with a remote that is not enabled,
so I don't know if that is a useful distinction to draw.
Also, if a file is not present in any remotes yet either, syncing will
not get it, and not fail, and leave the local repo without the file's
content. And this is not happening because a remote is not enabled,
but because there is no path to get the data from the repo that contains
it.
I did change the man page to say "The --content option causes the content of annexed files
to also be uploaded and downloaded as necessary, to sync the content between the repository and its remotes."
Which may be explcit enough to remove the ambiguity that surprised you,
but I'm not sure if I've hit on the right wording.
"""]]

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

@ -108,16 +108,18 @@ have the same value as the currently checked out branch.
Normally, syncing does not transfer the contents of annexed files. Normally, syncing does not transfer the contents of annexed files.
The --content option causes the content of annexed files The --content option causes the content of annexed files
to also be uploaded and downloaded as necessary. to also be uploaded and downloaded as necessary, to sync the content
between the repository and its remotes.
The `annex.synccontent` configuration can be set to true to make content The `annex.synccontent` configuration can be set to true to make content
be synced by default. be synced by default.
Normally this tries to get each annexed file that is in the working tree Normally this tries to get each annexed file that is in the working tree
and whose content the local repository does not yet have, and then copies and whose content the local repository does not yet have, from any remote
each file to every remote that it is syncing with. that it's syncing with that has a copy, and then copies each file to
This behavior can be overridden by configuring the preferred content every remote that it is syncing with. This behavior can be overridden by
of a repository. See [[git-annex-preferred-content]](1). configuring the preferred content of repositories. See
[[git-annex-preferred-content]](1).
* `--content-of=path` `-C path` * `--content-of=path` `-C path`