summaryrefslogtreecommitdiff
path: root/doc/special_remotes.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-08-01 18:10:02 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-08-01 18:10:02 -0400
commit7154019d814db09005a07a4e6a93365126f04f21 (patch)
tree373ebbf35cb170928dc92c1f4c08b2294ae9e357 /doc/special_remotes.mdwn
parentddbf5df3c9940473663a6e562f8ee3583867046e (diff)
document testremote
Diffstat (limited to 'doc/special_remotes.mdwn')
-rw-r--r--doc/special_remotes.mdwn18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/special_remotes.mdwn b/doc/special_remotes.mdwn
index 2ef98c40d..dd82d23f1 100644
--- a/doc/special_remotes.mdwn
+++ b/doc/special_remotes.mdwn
@@ -81,3 +81,21 @@ on special remotes, instead use `git annex unused --from`. Example:
(To remove unwanted data: git-annex dropunused --from mys3 NUMBER)
$ git annex dropunused --from mys3 1
dropunused 12948 (from mys3...) ok
+
+## Testing special remotes
+
+To make sure that a special remote is working correctly, you can use the
+`git annex testremote` command. This expects you to have set up the remote
+as usual, and it then runs a lot of tests, using random data. It's
+particularly useful to test new implementations of special remotes.
+
+By default it will upload and download files of around 1MiB to the remote
+it tests; the `--size` parameter can adjust it test using smaller files.
+
+It's safe to use this command even when you're already storing data in a
+remote; it won't touch your existing files stored on the remote.
+
+For most remotes, it also won't bloat the remote with any data, since
+it cleans up the stuff it uploads. However, the bup, ddar, and tahoe
+special remotes don't support removal of uploaded files, so be careful
+with those.