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

update docs to account for exporttree

Browse source
This commit is contained in:
Joey Hess 2023-04-25 12:15:14 -04:00
parent 722bb79dbf
commit 00b29d17ad
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/special_remotes/directory.mdwn
View file

@ -5,11 +5,13 @@ 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.
With the exporttree=yes parameter, the directory contains a tree of files
with the same filenames used in a branch of your repository. Without that
parameter, the directory contains a directory structure similar to
`.git/annex/objects` or other special remotes like [[rsync]].
Bear in mind that you can also use a regular `git clone` of your git-annex
repository, rather than a directory remote.
## configuration

7
doc/special_remotes/directory/comment_22_2be4b4e74a41723b72ef92a28f81a4dd._comment Normal file
View file

@ -0,0 +1,7 @@
[[!comment format=mdwn
username="joey"
subject="""Re: File visibility"""
date="2023-04-25T16:14:50Z"
content="""
Yes, that warning predated the exporttree feature. I've updated the docs.
"""]]