update docs to account for exporttree
authorJoey Hess <joeyh@joeyh.name>
Tue, 25 Apr 2023 16:15:14 +0000 (12:15 -0400)
committerJoey Hess <joeyh@joeyh.name>
Tue, 25 Apr 2023 16:15:14 +0000 (12:15 -0400)
doc/special_remotes/directory.mdwn
doc/special_remotes/directory/comment_22_2be4b4e74a41723b72ef92a28f81a4dd._comment [new file with mode: 0644]

index 5fc99961ebe54fdee7704dd2693cadfd0cc9e28b..b984d1ec5fb5155d0b022d80f9ee5a8a8d2bfdf6 100644 (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
 
diff --git a/doc/special_remotes/directory/comment_22_2be4b4e74a41723b72ef92a28f81a4dd._comment b/doc/special_remotes/directory/comment_22_2be4b4e74a41723b72ef92a28f81a4dd._comment
new file mode 100644 (file)
index 0000000..62e74f8
--- /dev/null
@@ -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.
+"""]]