Re: [RFC PATCH 4/6] Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt

From: Junio C Hamano <gitster@pobox.com>
To: Kenneth Lorber <keni@hers.com>
Cc: git@vger.kernel.org
Subject: Re: [RFC PATCH 4/6] Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt
Date: Sun, 17 May 2020 17:26:21 -0700	[thread overview]
Message-ID: <xmqqr1vi5brm.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <1589681624-36969-5-git-send-email-keni@hers.com> (Kenneth Lorber's message of "Sat, 16 May 2020 22:13:42 -0400")

Kenneth Lorber <keni@hers.com> writes:

> From: Kenneth Lorber <keni@his.com>
>
> Signed-off-by: Kenneth Lorber <keni@his.com>
> ---
>  Documentation/gitrepository-layout.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

As I said elsewhere, I am not sure if we want to even let
third-party tools direct access at the filesystem level to
$GIT_DIR/.  We do want to say things like where the ref namespace
that are taken as "per worktree" are located, so that a third-party
tool wants to carve out a hierarchy out of the per-worktree part of
the ref namespace, that may indirectly influence where on the
filesystem under $GIT_DIR/ their stuff is stored, but how we decide
to store refs inside $GIT_DIR/ should still be blackbox to these
third-party tools (e.g. we may not be using loose or packed refs,
but using a chain of reftable files).  

So from that point of view, we shouldn't have to touch the
repository layout document, I would think.

> diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
> index a84a4df513..8050e8cc1f 100644
> --- a/Documentation/gitrepository-layout.txt
> +++ b/Documentation/gitrepository-layout.txt
> @@ -290,9 +290,10 @@ worktrees/<id>/locked::
>  worktrees/<id>/config.worktree::
>  	Working directory specific configuration file.
>  
> -include::technical/namespace-collisions.txt[]
>  include::technical/repository-version.txt[]
>  
> +include::technical/namespace-collisions.txt[]
> +
>  SEE ALSO
>  --------
>  linkgit:git-init[1],