From: Junio C Hamano <gitster@pobox.com>
To: kristofferhaugsbakk@fastmail.com
Cc: git@vger.kernel.org, Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: Re: [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page”
Date: Mon, 06 Apr 2026 10:04:10 -0700 [thread overview]
Message-ID: <xmqqy0j0aulx.fsf@gitster.g> (raw)
In-Reply-To: <V2_gitcvs_doc_link.56b@msgid.xyz> (kristofferhaugsbakk@fastmail.com's message of "Sun, 5 Apr 2026 12:32:00 +0200")
kristofferhaugsbakk@fastmail.com writes:
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Let’s change the phrasing around the `linkgit` while we’re visiting this
> file (see previous commit[1]).
>
> We use the section syntax to refer to man pages, so writing “man page”
> next to it is a bit redundant. We can be more concise and just lean on
> the preposition “in”.
Being succinct is better ;-).
> And in order to avoid this double “git”:
>
> see `git config list` in git-config(1) ...
>
> We can rephrase to the subcommand, which is a typical pattern (config or
> option followed by “in git-command(1)”).
Again, being succinct is very good.
> † 1: Which also discusses why we do not change a similar phrasing
> in gittutorial(7)
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>
> Notes (series):
> v2:
> • Just the “man page” change, which now comes after the --list/-l change
> • Restructure commit message paragraph so that it leads with “section
> syntax” and has a simpler structure.
> • Footnote to remind what was discussed on the previous commit
> v1: (combined --list/-l change and “man page” change)
>
> Documentation/gitcvs-migration.adoc | 3 +--
> 1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/gitcvs-migration.adoc b/Documentation/gitcvs-migration.adoc
> index 2883834b714..905d08cd5f9 100644
> --- a/Documentation/gitcvs-migration.adoc
> +++ b/Documentation/gitcvs-migration.adoc
> @@ -49,8 +49,7 @@ them first before running git pull.
> ================================
> The 'pull' command knows where to get updates from because of certain
> configuration variables that were set by the first 'git clone'
> -command; see `git config list` and the linkgit:git-config[1] man
> -page for details.
> +command; see the subcommand `list` in linkgit:git-config[1] for details.
> ================================
>
> You can update the shared repository with your changes by first committing
prev parent reply other threads:[~2026-04-06 17:04 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-03-31 20:48 [PATCH 0/3] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
2026-03-31 20:48 ` [PATCH 1/3] doc: var: link -l to git config list kristofferhaugsbakk
2026-03-31 21:12 ` Junio C Hamano
2026-03-31 21:14 ` Kristoffer Haugsbakk
2026-03-31 20:48 ` [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase kristofferhaugsbakk
2026-03-31 21:09 ` Junio C Hamano
2026-03-31 21:17 ` Kristoffer Haugsbakk
2026-03-31 20:48 ` [PATCH 3/3] doc: replace the rest of git config --list with `list` kristofferhaugsbakk
2026-03-31 21:10 ` Junio C Hamano
2026-04-05 10:31 ` [PATCH v2 0/2] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
2026-04-05 10:31 ` [PATCH v2 1/2] doc: replace git config --list/-l with `list` kristofferhaugsbakk
2026-04-05 10:32 ` [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page” kristofferhaugsbakk
2026-04-06 17:04 ` 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqy0j0aulx.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=kristofferhaugsbakk@fastmail.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox