summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-11-08 13:02:42 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-11-08 13:02:42 -0400
commit6356491919593b98d5a5573f05d6660e75a4963e (patch)
treee5664f4d424c766b52565959fdde3befa71d091a
parent0213e12772de67a25beae87f097d38f39246edf9 (diff)
improve testremote docs
-rw-r--r--doc/git-annex-testremote.mdwn9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/git-annex-testremote.mdwn b/doc/git-annex-testremote.mdwn
index fff08fdcc..5c3a5ca5b 100644
--- a/doc/git-annex-testremote.mdwn
+++ b/doc/git-annex-testremote.mdwn
@@ -14,9 +14,12 @@ the remote, then redownloading them, removing them from the remote, etc.
It's safe to run in an existing repository (the repository contents are
not altered), although it may perform expensive data transfers.
-Testing a single remote will use the remote's configuration,
-automatically varying the chunk sizes, and with simple shared encryption
-enabled and disabled.
+It's best to make a new remote for testing purposes. While the test
+tries to clean up after itself, if the remote being tested had a bug,
+the cleanup might fail, leaving test data in the remote.
+
+Testing will use the remote's configuration, automatically varying
+the chunk sizes, and with simple shared encryption enabled and disabled.
# OPTIONS