[PATCH] Documentation: Correct alternates documentation, document http-alternates
From: Petr Baudis <hidden>
Date: 2016-08-11 19:33:15
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 <redacted> --- Documentation/repository-layout.txt | 17 ++++++++++++++--- 1 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt
index fd9f406..73a025b 100644
--- a/Documentation/repository-layout.txt
+++ b/Documentation/repository-layout.txt@@ -52,9 +52,20 @@ objects/info/packs:: by default. objects/info/alternates:: - This file records absolute filesystem paths of alternate - object stores that this object store borrows objects - from, one pathname per line. + This file records paths to alternate object stores that + this object store borrows objects from, one pathname per + line. Note that not only native Git tools use it locally, + but the HTTP fetcher also tries to use it remotely; this + will usually work if you have relative paths (relative + to the object database, not to the repository!) in your + alternates file, but it will not work if you use absolute + paths unless the absolute path in filesystem and web URL + is the same. See also 'objects/info/http-alternates'. + +objects/info/http-alternates:: + This file records URLs to alternate object stores that + this object store borrows objects from, to be used when + the repository is fetched over HTTP. refs::