From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: "Matthias Aßhauer via GitGitGadget" <gitgitgadget@gmail.com>,
git@vger.kernel.org, "Matthias Aßhauer" <mha1993@live.de>
Subject: Re: [PATCH 2/2] documentation: add documentation for 'git version'
Date: Mon, 13 Sep 2021 12:43:28 -0700 [thread overview]
Message-ID: <xmqq4kaofehr.fsf@gitster.g> (raw)
In-Reply-To: <87r1ds4t3w.fsf@evledraar.gmail.com> ("Ævar Arnfjörð Bjarmason"'s message of "Mon, 13 Sep 2021 13:19:11 +0200")
Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:
>> +Note that `git --version` is identical to `git version` because the
>> +former is internally converted into the latter.
>
> Probably better to just have a new section:
>
> SEE ALSO
> --------
>
> linkgit:git[1]'s `--version` option, which dispatches to this command.
Hmph, I am not sure if this is a good move.
If we are not giving any more information than what the reader has
already learned from this page, other than "git --version" does the
same thing, we probably do not want to do this. By seeing also that
other page, the user will not learn anything new about "git version".
If a related "git --version-something-else" is described over there
and may fill the need the reader had when visiting this page, that
is a different story, but I do not think it is the case.
>> +OPTIONS
>> +-------
>> +--build-options::
>> + Prints out additional information about how git was built for diagnostic
>> + purposes.
>> +
>> +GIT
>> +---
>> +Part of the linkgit:git[1] suite
>
>
> It would also be good to update git.txt, which now says:
>
> Prints the Git suite version that the git program came from
>
> To say e.g. "Dispatches to linkgit:git-version[1], prints the git
> program version".
This one may be a good idea, I think.
"git --version --build-options" also works and we do not want to
clutter git[1] with descriptions on suboptions of "git version".
If we are not doing so for the "--help" option in git[1], we should
do so as well.
Thanks.
next prev parent reply other threads:[~2021-09-13 19:43 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-13 11:06 [PATCH 0/2] documentation: handle non-existing html pages and document 'git version' Matthias Aßhauer via GitGitGadget
2021-09-13 11:06 ` [PATCH 1/2] help: make sure local html page exists before calling external processes Matthias Aßhauer via GitGitGadget
2021-09-13 15:59 ` Eric Sunshine
2021-09-13 16:17 ` Matthias Aßhauer
2021-09-13 19:25 ` Junio C Hamano
2021-09-13 11:06 ` [PATCH 2/2] documentation: add documentation for 'git version' Matthias Aßhauer via GitGitGadget
2021-09-13 11:19 ` Ævar Arnfjörð Bjarmason
2021-09-13 11:46 ` Matthias Aßhauer
2021-09-13 19:43 ` Junio C Hamano [this message]
2021-09-14 13:27 ` [PATCH v2 0/2] documentation: handle non-existing html pages and document " Matthias Aßhauer via GitGitGadget
2021-09-14 13:27 ` [PATCH v2 1/2] help: make sure local html page exists before calling external processes Matthias Aßhauer via GitGitGadget
2021-09-14 13:27 ` [PATCH v2 2/2] documentation: add documentation for 'git version' Matthias Aßhauer via GitGitGadget
2021-09-24 13:00 ` Is "make check-docs" useful anymore? Ævar Arnfjörð Bjarmason
2021-09-24 17:59 ` Junio C Hamano
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq4kaofehr.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=mha1993@live.de \
/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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.