From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: "Matthias Aßhauer via GitGitGadget" <gitgitgadget@gmail.com>
Cc: 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 13:19:11 +0200 [thread overview]
Message-ID: <87r1ds4t3w.fsf@evledraar.gmail.com> (raw)
In-Reply-To: <d3635cbfd6ef0d47ebf28c516476dcd0b718afd4.1631531219.git.gitgitgadget@gmail.com>
On Mon, Sep 13 2021, Matthias Aßhauer via GitGitGadget wrote:
> From: =?UTF-8?q?Matthias=20A=C3=9Fhauer?= <mha1993@live.de>
>
> While 'git version' is probably the least complex git command,
> it is a non-experimental user-facing builtin command. As such
> it should have a help page.
This looks good
> Signed-off-by: Matthias Aßhauer <mha1993@live.de>
> ---
> Documentation/git-version.txt | 35 +++++++++++++++++++++++++++++++++++
> 1 file changed, 35 insertions(+)
> create mode 100644 Documentation/git-version.txt
>
> diff --git a/Documentation/git-version.txt b/Documentation/git-version.txt
> new file mode 100644
> index 00000000000..c7d6b496c8d
> --- /dev/null
> +++ b/Documentation/git-version.txt
> @@ -0,0 +1,35 @@
> +git-version(1)
> +==============
> +
> +NAME
> +----
> +git-version - Display version information about Git
> +
> +
> +SYNOPSIS
> +--------
> +[verse]
> +'git version' [--build-options]
>
> +
> +DESCRIPTION
> +-----------
> +
> +With no options given, the version of 'git' is printed
> +on the standard output.
Good
> +
> +If the option `--build-options` is given, information about how git was built is
> +printed on the standard output in addition to the version number.
Let's just cover this in the OPTIONS section you added...
> +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.
> +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".
Or something like that, i.e. to cross-link the two.
next prev parent reply other threads:[~2021-09-13 11:23 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 [this message]
2021-09-13 11:46 ` Matthias Aßhauer
2021-09-13 19:43 ` Junio C Hamano
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
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=87r1ds4t3w.fsf@evledraar.gmail.com \
--to=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.
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).