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

improve directory special remote docs

Browse source
This commit is contained in:
Joey Hess 2014-02-02 15:26:33 -04:00
parent a542781f6a
commit 18c98c8cfa
2 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/bugs/tweaks_to_directory_special_remote_doco.mdwn
View file

@ -72,3 +72,9 @@ Below is an untested patch that I think would make the documentation more helpfu
# End of transcript or log.
> Largely applied (except example at the end). I agree these
> changes make it much clearer, especially adding the missing documentation
> of the directory parameter. So, [[done]]. Note that this website is a
> wiki and users like you are welcome to edit pages directly to improve the
> documentation. --[[Joey]]

8
doc/special_remotes/directory.mdwn
View file

@ -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]].