Re* [PATCH 4/4] Add documentation for ref namespaces
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Sep 16, 2011, 00:22 UTC
- Message-ID
- <7vaaa5pc8q.fsf_-_@alter.siamese.dyndns.org>
- In-Reply-To
- <CACBZZX4bow8vwrwSL5uRJQtAgeg10_K+5ss8u-HvCHOn3+0Tuw@mail.gmail.com>
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
Show 7 quoted lines
> On Tue, Jun 7, 2011 at 20:21, Jamey Sharp <jamey@minilop.net> wrote: > >> Document the namespace mechanism in a new gitnamespaces(7) page. >> Reference it from receive-pack and upload-pack. > > This breaks the build on older asciidoc versions, the fix is to do > what I did in f5008f56d5aba06598e1c6272f4f55b4ee4bb016.
Earlier I sent out a tongue-in-cheek "like this" that had a completely bogus SYNOPSIS section that is unusable in a released version of Git, hoping that somebody who _care_ more about the feature that the page describes would give us a better wording, but unfortunately it never happened.
So here is a more realistic replacement, so that we won't have to suffer by complaints from people with older AsciiDoc saying "the release does not build". If we were to include this in 1.7.7 final, we now need to make sure we won't to have to hear from people with newer AsciiDoc saying "why do we have nonsense in SYNOPSIS section", so your help is needed here.
I explicitly avoided saying:
[verse] export GIT_NAMESPACE=<namespace>
as nothing other than the selected transports seems to pay attention to this environment variable.
-- >8 -- Subject: [PATCH] Documentation/gitnamespaces.txt: cater to older asciidoc
Older asciidoc (e.g. 8.2.5 on Centos 5.5) is unhappy if a manpage does not have a SYNOPSIS section. Show a sample (and a possibly bogus) command line of running two commands that pay attention to this environment variable with a customized value.
Signed-off-by: Junio C Hamano <gitster@pobox.com> --- Documentation/gitnamespaces.txt | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-)
diff --git a/Documentation/gitnamespaces.txt b/Documentation/gitnamespaces.txt index ed8924e..c6713cf 100644 --- a/Documentation/gitnamespaces.txt +++ b/Documentation/gitnamespaces.txt @@ -5,6 +5,13 @@ NAME ---- gitnamespaces - Git namespaces +SYNOPSIS +-------- +[verse] +GIT_NAMESPACE=<namespace> 'git upload-pack' +GIT_NAMESPACE=<namespace> 'git receive-pack' + + DESCRIPTION -----------
-- 1.7.7.rc1.3.g559357