Add note to 'satisfy' manpage about it not satisfying numcopies and how to set it...

I got bitten several times in the past by the fact that local preferred
content expressions are not violated (even temporarily) in order to
satisfy numcopies or other remotes' preferred content expressions.
Mostly in the form of the local repo not allowing arbitrary files in
(e.g. because it's set to only want `present` files). This note I add
here explains how to get out of this situation with
`approxlackingcopies=1`.

It might be too specific for this manpage, but I didn't find a better
place to put it.

diff --git a/doc/git-annex-satisfy.mdwn b/doc/git-annex-satisfy.mdwn
index ddbec766aec1795be525c94e94615a0a7b5f7e9c..e71d6dc6741c37f96e23a9b6e8ce8e7b11e975b0 100644 (file)
--- a/doc/git-annex-satisfy.mdwn
+++ b/doc/git-annex-satisfy.mdwn
@@ -15,6 +15,16 @@ It does the same thing as `git-annex sync --content` without the pulling
 and pushing of git repositories, and without changing the trees that are
 imported to or exported from special remotes.
 
+Note that it (like [[git-annex-sync]] or [[git-annex-assist]]) does not work
+specifically towards satisfying the [[git-annex-numcopies]] setting and it will
+not violate the local preferred content expression in order to move files
+between remotes that are not present locally. To allow for files to be present
+locally for such a movement between remotes, consider adding `or
+approxlackingcopies=1` to your local [[preferred_content]] expression (and
+maybe increasing [[git-annex-numcopies]] accordingly) so that files may pass
+through your local repo temporarily. Otherwise, `git annex satisfy` does not
+see a pathway for files to pass between other remotes.
+
 # OPTIONS
 
 * `[remote]`