Documentation: Correct alternates documentation, document http-alternates
For one, the documentation invalidly claimed that the paths have to be absolute when that's not the case and in fact there is a very valid reason not to use absolute paths (documented the reason as well). Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Petr Baudis committed
Nov 19, 2006 at 00:30 UTC
198a4f4ff0694cb5b906278fc1c2b6e7db4d2737
1 file changed
+14
-3
Documentation/repository-layout.txt
+14
-3
@@ -52,9 +52,20 @@ objects/info/packs::
52
by default.
53
54
objects/info/alternates::
55
- This file records absolute filesystem paths of alternate
56
- object stores that this object store borrows objects
57
- from, one pathname per line.
55
+ This file records paths to alternate object stores that
56
+ this object store borrows objects from, one pathname per
57
+ line. Note that not only native Git tools use it locally,
58
+ but the HTTP fetcher also tries to use it remotely; this
59
+ will usually work if you have relative paths (relative
60
+ to the object database, not to the repository!) in your
61
+ alternates file, but it will not work if you use absolute
62
+ paths unless the absolute path in filesystem and web URL
63
+ is the same. See also 'objects/info/http-alternates'.
64
+
65
+objects/info/http-alternates::
66
+ This file records URLs to alternate object stores that
67
+ this object store borrows objects from, to be used when
68
+ the repository is fetched over HTTP.
69
70
refs::
71
References are stored in subdirectories of this