From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, John Cai <johncai86@gmail.com>
Subject: Re: [PATCH] doc txt & -h consistency: fix recent "cat-file" inconsistency
Date: Fri, 08 Apr 2022 11:33:54 -0700 [thread overview]
Message-ID: <xmqqee27mnl9.fsf@gitster.g> (raw)
In-Reply-To: <220408.864k34c4wo.gmgdl@evledraar.gmail.com> ("Ævar Arnfjörð Bjarmason"'s message of "Fri, 08 Apr 2022 10:55:46 +0200")
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
> I think both should have the long form, but we don't need to argue that
> point here.
Right.
>> Side note: and no, we do not want to tie the documentation to a
>> particular build too tightly, and it is a no-no to generate the
>> documentation source from 'git cmd -h' output. Even when an
>> option is conditionally excluded from a particular build, I'd
>> like to be able to build and publish documentation for wider
>> audience than just to myself.
>
> I don't have changes to do that, but I think the particular concern
> you're airing here isn't an issue at all.
>
> I.e. whatever other issues we'd enocunter with such auto-generation we
> do not have *options* that are conditional on compilation, nor do we
> have commands that we build and don't build the corresponding
> documentation for.
The above seems to only scratch the status quo, while I was with
maintainer's hat on when I wrote the above, and was considering
future possibilities as well. I can very much see us accepting a
patch to make "git grep -h" not showing "-P" when Git is built
without pcre support, for example.
Saying "at all", is a bit too strong with the argument you have, I
am afraid.
prev parent reply other threads:[~2022-04-08 18:34 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-07 19:08 [PATCH] doc txt & -h consistency: fix recent "cat-file" inconsistency Ævar Arnfjörð Bjarmason
2022-04-07 20:27 ` Junio C Hamano
2022-04-08 8:55 ` Ævar Arnfjörð Bjarmason
2022-04-08 18:33 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqee27mnl9.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=johncai86@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).