summaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-02 15:26:33 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-02 15:26:33 -0400
commit95cfa71a0630006b86eb4dfa891ef6ed799490e2 (patch)
tree8dbf21bf66a093b4be9ef4dead54e4ecaa198b6d /doc/special_remotes
parentf936e91ef1f494ff475dd62f13711e673e475b3c (diff)
improve directory special remote docs
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/directory.mdwn8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/special_remotes/directory.mdwn b/doc/special_remotes/directory.mdwn
index 4d72e8bee..b79cf7544 100644
--- a/doc/special_remotes/directory.mdwn
+++ b/doc/special_remotes/directory.mdwn
@@ -1,10 +1,12 @@
This special remote type stores file contents in directory.
One use case for this would be if you have a removable drive that
-you want to use it to sneakernet files between systems (possibly with
+you want to use to sneakernet files between systems (possibly with
[[encrypted|encryption]] contents). Just set up both systems to use
the drive's mountpoint as a directory remote.
+Note that directory remotes have a special directory structure
+(by design, the same as the \[[rsync|rsync]] remote).
If you just want two copies of your repository with the files "visible"
in the tree in both, the directory special remote is not what you want.
Instead, you should use a regular `git clone` of your git-annex repository.
@@ -14,6 +16,10 @@ Instead, you should use a regular `git clone` of your git-annex repository.
These parameters can be passed to `git annex initremote` to configure the
remote:
+* `directory` - The path to the directory where the files should be stored
+ for the remote. The directory must already exist. Typically this will
+ be an empty directory, or a directory already used as a directory remote.
+
* `encryption` - One of "none", "hybrid", "shared", or "pubkey".
See [[encryption]].