Git development
 help / color / mirror / Atom feed
* [PATCH 0/3] doc: replace mentions of deprecated git config --list
@ 2026-03-31 20:48 kristofferhaugsbakk
  2026-03-31 20:48 ` [PATCH 1/3] doc: var: link -l to git config list kristofferhaugsbakk
                   ` (3 more replies)
  0 siblings, 4 replies; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-03-31 20:48 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk, ps

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Topic name: kh/doc-config-no-deprecated-list-opt

Topic summary: Replace uses of deprecated `git config --list` with its
replacement `git config list` from topic ps/config-subcommands.

I found `git config -l` in git-var(1) and searched for other occurrences.
I have not considered the other deprecated options.

[1/3] doc: var: link -l to git config list
[2/3] doc: gitcvs-migration: replace config -l and rephrase
[3/3] doc: replace the rest of git config --list with `list`

 Documentation/git-var.adoc              | 5 +++--
 Documentation/gitcvs-migration.adoc     | 3 +--
 Documentation/gitprotocol-v2.adoc       | 2 +-
 Documentation/gittutorial.adoc          | 2 +-
 Documentation/technical/api-trace2.adoc | 2 +-
 Documentation/user-manual.adoc          | 2 +-
 6 files changed, 8 insertions(+), 8 deletions(-)


base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH 1/3] doc: var: link -l to git config list
  2026-03-31 20:48 [PATCH 0/3] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
@ 2026-03-31 20:48 ` kristofferhaugsbakk
  2026-03-31 21:12   ` Junio C Hamano
  2026-03-31 20:48 ` [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase kristofferhaugsbakk
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-03-31 20:48 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk, ps

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

The option `-l` is deprecated and links to `git config -l` as the
replacement—which is also deprecated. Break the deprecation chain by
linking to `git config list`, the command which has superseded `git
config -l`.

Also promote this part from a parenthetical to a warning admonition.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-var.adoc | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc
index b606c2d6499..98f4dc1a479 100644
--- a/Documentation/git-var.adoc
+++ b/Documentation/git-var.adoc
@@ -21,8 +21,9 @@ OPTIONS
 `-l`::
 	Display the logical variables. In addition, all the
 	variables of the Git configuration file .git/config are listed
-	as well. (However, the configuration variables listing functionality
-	is deprecated in favor of `git config -l`.)
+	as well.
++
+WARNING: Deprecated in favor of `git config list`.
 
 EXAMPLES
 --------
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase
  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 20:48 ` kristofferhaugsbakk
  2026-03-31 21:09   ` Junio C Hamano
  2026-03-31 20:48 ` [PATCH 3/3] doc: replace the rest of git config --list with `list` kristofferhaugsbakk
  2026-04-05 10:31 ` [PATCH v2 0/2] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
  3 siblings, 1 reply; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-03-31 20:48 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk, ps

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Replace `git config -l` with the subcommand `list` since `-l`
is deprecated.

Let’s also change the phrasing around the `linkgit` while we’re visiting
this file.

The Git documentation pages are both manual pages and HTML pages, and in
any case we already use the section syntax to refer to them. So we don’t
have to say “the _ man page”; we can be a bit more concise and only lean
on the preposition “in”.

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)”).

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    But this does make it more difficult to find back to later.

 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 1cd1283d0f8..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 -l` 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
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* [PATCH 3/3] doc: replace the rest of git config --list with `list`
  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 20:48 ` [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase kristofferhaugsbakk
@ 2026-03-31 20:48 ` 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
  3 siblings, 1 reply; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-03-31 20:48 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk, ps

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Replace the rest of `git config --list` (short or long) with the
subcommand `list` since `--list` is deprecated.

Note that we leave the “man page” phrasing alone in the Git tutorial
since it’s a tutorial and not a manual page. We can be more wordy in a
tutorial context.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/gitprotocol-v2.adoc       | 2 +-
 Documentation/gittutorial.adoc          | 2 +-
 Documentation/technical/api-trace2.adoc | 2 +-
 Documentation/user-manual.adoc          | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/gitprotocol-v2.adoc b/Documentation/gitprotocol-v2.adoc
index c7db103299a..ec2562fb0a1 100644
--- a/Documentation/gitprotocol-v2.adoc
+++ b/Documentation/gitprotocol-v2.adoc
@@ -659,7 +659,7 @@ use by the client, MUST indicate prerequisites (in any) with standard
 applicable.
 +
 The advertised URI may alternatively contain a plaintext file that `git
-config --list` would accept (with the `--file` option). The key-value
+config list` would accept (with the `--file` option). The key-value
 pairs in this list are in the `bundle.*` namespace (see
 linkgit:git-config[1]).
 
diff --git a/Documentation/gittutorial.adoc b/Documentation/gittutorial.adoc
index f89ad30cf65..519b8d8be2c 100644
--- a/Documentation/gittutorial.adoc
+++ b/Documentation/gittutorial.adoc
@@ -432,7 +432,7 @@ bob$ git config --get remote.origin.url
 -------------------------------------
 
 (The complete configuration created by `git clone` is visible using
-`git config -l`, and the linkgit:git-config[1] man page
+`git config list`, and the linkgit:git-config[1] man page
 explains the meaning of each option.)
 
 Git also keeps a pristine copy of Alice's `master` branch under the
diff --git a/Documentation/technical/api-trace2.adoc b/Documentation/technical/api-trace2.adoc
index cf493dae03f..918e517c2e6 100644
--- a/Documentation/technical/api-trace2.adoc
+++ b/Documentation/technical/api-trace2.adoc
@@ -1253,7 +1253,7 @@ it.
 $ git config --system color.ui never
 $ git config --global color.ui always
 $ git config --local color.ui auto
-$ git config --list --show-scope | grep 'color.ui'
+$ git config list --show-scope | grep 'color.ui'
 system  color.ui=never
 global  color.ui=always
 local   color.ui=auto
diff --git a/Documentation/user-manual.adoc b/Documentation/user-manual.adoc
index 76969871176..3cd94c7afa1 100644
--- a/Documentation/user-manual.adoc
+++ b/Documentation/user-manual.adoc
@@ -2865,7 +2865,7 @@ stored in Git configuration variables, which you can see using
 linkgit:git-config[1]:
 
 -------------------------------------------------
-$ git config -l
+$ git config list
 core.repositoryformatversion=0
 core.filemode=true
 core.logallrefupdates=true
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* Re: [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase
  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
  0 siblings, 1 reply; 13+ messages in thread
From: Junio C Hamano @ 2026-03-31 21:09 UTC (permalink / raw)
  To: kristofferhaugsbakk; +Cc: git, Kristoffer Haugsbakk, ps

kristofferhaugsbakk@fastmail.com writes:

> diff --git a/Documentation/gitcvs-migration.adoc b/Documentation/gitcvs-migration.adoc
> index 1cd1283d0f8..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 -l` and the linkgit:git-config[1] man
> -page for details.
> +command; see the subcommand `list` in linkgit:git-config[1] for details.
>  ================================

OK.  In this step, "while at it" change is also sensible, unlike the
one in [1/3].  It wouldn't have been time-wasting if you sifted the
patches into "genuinely, move away from -l and to 'list'" changes
and everything else, as the former we do not have to think, while
the latter we do.


^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 3/3] doc: replace the rest of git config --list with `list`
  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
  0 siblings, 0 replies; 13+ messages in thread
From: Junio C Hamano @ 2026-03-31 21:10 UTC (permalink / raw)
  To: kristofferhaugsbakk; +Cc: git, Kristoffer Haugsbakk, ps

kristofferhaugsbakk@fastmail.com writes:

> diff --git a/Documentation/gitprotocol-v2.adoc b/Documentation/gitprotocol-v2.adoc
> index c7db103299a..ec2562fb0a1 100644
> --- a/Documentation/gitprotocol-v2.adoc
> +++ b/Documentation/gitprotocol-v2.adoc
> @@ -659,7 +659,7 @@ use by the client, MUST indicate prerequisites (in any) with standard
>  applicable.
>  +
>  The advertised URI may alternatively contain a plaintext file that `git
> -config --list` would accept (with the `--file` option). The key-value
> +config list` would accept (with the `--file` option). The key-value
>  pairs in this list are in the `bundle.*` namespace (see
>  linkgit:git-config[1]).

OK.

> diff --git a/Documentation/gittutorial.adoc b/Documentation/gittutorial.adoc
> index f89ad30cf65..519b8d8be2c 100644
> --- a/Documentation/gittutorial.adoc
> +++ b/Documentation/gittutorial.adoc
> @@ -432,7 +432,7 @@ bob$ git config --get remote.origin.url
>  -------------------------------------
>  
>  (The complete configuration created by `git clone` is visible using
> -`git config -l`, and the linkgit:git-config[1] man page
> +`git config list`, and the linkgit:git-config[1] man page
>  explains the meaning of each option.)
>  
>  Git also keeps a pristine copy of Alice's `master` branch under the
> diff --git a/Documentation/technical/api-trace2.adoc b/Documentation/technical/api-trace2.adoc
> index cf493dae03f..918e517c2e6 100644
> --- a/Documentation/technical/api-trace2.adoc
> +++ b/Documentation/technical/api-trace2.adoc
> @@ -1253,7 +1253,7 @@ it.
>  $ git config --system color.ui never
>  $ git config --global color.ui always
>  $ git config --local color.ui auto
> -$ git config --list --show-scope | grep 'color.ui'
> +$ git config list --show-scope | grep 'color.ui'
>  system  color.ui=never
>  global  color.ui=always
>  local   color.ui=auto
> diff --git a/Documentation/user-manual.adoc b/Documentation/user-manual.adoc
> index 76969871176..3cd94c7afa1 100644
> --- a/Documentation/user-manual.adoc
> +++ b/Documentation/user-manual.adoc
> @@ -2865,7 +2865,7 @@ stored in Git configuration variables, which you can see using
>  linkgit:git-config[1]:
>  
>  -------------------------------------------------
> -$ git config -l
> +$ git config list
>  core.repositoryformatversion=0
>  core.filemode=true
>  core.logallrefupdates=true

Looking good.

Thanks.

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/3] doc: var: link -l to git config list
  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
  0 siblings, 1 reply; 13+ messages in thread
From: Junio C Hamano @ 2026-03-31 21:12 UTC (permalink / raw)
  To: kristofferhaugsbakk; +Cc: git, Kristoffer Haugsbakk, ps

kristofferhaugsbakk@fastmail.com writes:

> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> The option `-l` is deprecated and links to `git config -l` as the
> replacement—which is also deprecated. Break the deprecation chain by
> linking to `git config list`, the command which has superseded `git
> config -l`.
>
> Also promote this part from a parenthetical to a warning admonition.
>
> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
> ---
>  Documentation/git-var.adoc | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc
> index b606c2d6499..98f4dc1a479 100644
> --- a/Documentation/git-var.adoc
> +++ b/Documentation/git-var.adoc
> @@ -21,8 +21,9 @@ OPTIONS
>  `-l`::
>  	Display the logical variables. In addition, all the
>  	variables of the Git configuration file .git/config are listed
> -	as well. (However, the configuration variables listing functionality
> -	is deprecated in favor of `git config -l`.)
> +	as well.
> ++
> +WARNING: Deprecated in favor of `git config list`.

This changes the meaning, and I am afraid in a bad way.

Use if "git var -l" to ask values of configuration variables is
deprecated, as we would encourage use of "git config [-l | list]".
"git var -l" is and will stay to be the way to ask about logical
variables.

The new text, unlike the original, does not limit the deprecation
only for asking about configuration variables.

The logical variables are called logical because their values are
synthesized from information taken from different places (e.g., you
might not have user.name configured but may have GIT_AUTHOR_NAME
environment variable set and exported or your name configured
correctly in GECOS field.  We can ask what the value of
GIT_AUTHOR_IDENT is, without knowing where that value comes from,
and the source might be outside the usual Git configuration
subsystem, which makes it "logical").

I'd prefer to see this step just stick to `git config -l` => `git config list`
rewrite without the separate WARNING: style change.



^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 1/3] doc: var: link -l to git config list
  2026-03-31 21:12   ` Junio C Hamano
@ 2026-03-31 21:14     ` Kristoffer Haugsbakk
  0 siblings, 0 replies; 13+ messages in thread
From: Kristoffer Haugsbakk @ 2026-03-31 21:14 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Patrick Steinhardt

On Tue, Mar 31, 2026, at 23:12, Junio C Hamano wrote:
>>[snip]
>> ++
>> +WARNING: Deprecated in favor of `git config list`.
>
> This changes the meaning, and I am afraid in a bad way.
>
> Use if "git var -l" to ask values of configuration variables is
> deprecated, as we would encourage use of "git config [-l | list]".
> "git var -l" is and will stay to be the way to ask about logical
> variables.
>
> The new text, unlike the original, does not limit the deprecation
> only for asking about configuration variables.
>
> The logical variables are called logical because their values are
> synthesized from information taken from different places (e.g., you
> might not have user.name configured but may have GIT_AUTHOR_NAME
> environment variable set and exported or your name configured
> correctly in GECOS field.  We can ask what the value of
> GIT_AUTHOR_IDENT is, without knowing where that value comes from,
> and the source might be outside the usual Git configuration
> subsystem, which makes it "logical").
>
> I'd prefer to see this step just stick to `git config -l` => `git config list`
> rewrite without the separate WARNING: style change.

Aye! I missed that it was only talking about parts of the behavior.

I’ll drop the admonition change.

^ permalink raw reply	[flat|nested] 13+ messages in thread

* Re: [PATCH 2/3] doc: gitcvs-migration: replace config -l and rephrase
  2026-03-31 21:09   ` Junio C Hamano
@ 2026-03-31 21:17     ` Kristoffer Haugsbakk
  0 siblings, 0 replies; 13+ messages in thread
From: Kristoffer Haugsbakk @ 2026-03-31 21:17 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git, Patrick Steinhardt

On Tue, Mar 31, 2026, at 23:09, Junio C Hamano wrote:
> kristofferhaugsbakk@fastmail.com writes:
>
>> diff --git a/Documentation/gitcvs-migration.adoc b/Documentation/gitcvs-migration.adoc
>> index 1cd1283d0f8..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 -l` and the linkgit:git-config[1] man
>> -page for details.
>> +command; see the subcommand `list` in linkgit:git-config[1] for details.
>>  ================================
>
> OK.  In this step, "while at it" change is also sensible, unlike the
> one in [1/3].  It wouldn't have been time-wasting if you sifted the
> patches into "genuinely, move away from -l and to 'list'" changes
> and everything else, as the former we do not have to think, while
> the latter we do.

Okay. That’s great. I am far to the side of separating changes in terms
of personal inclination.

I’ll split the -l/--list change and the While At Its.

Thanks!

^ permalink raw reply	[flat|nested] 13+ messages in thread

* [PATCH v2 0/2] doc: replace mentions of deprecated git config --list
  2026-03-31 20:48 [PATCH 0/3] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
                   ` (2 preceding siblings ...)
  2026-03-31 20:48 ` [PATCH 3/3] doc: replace the rest of git config --list with `list` kristofferhaugsbakk
@ 2026-04-05 10:31 ` 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
  3 siblings, 2 replies; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-04-05 10:31 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Topic name: kh/doc-config-no-deprecated-list-opt

Topic summary: Replace uses of deprecated `git config --list` with its
replacement `git config list` from topic ps/config-subcommands.

I found `git config -l` in git-var(1) and searched for other occurrences.
I have not considered the other deprecated options.

CHANGES IN V2

Do all the straightforward deprecated-to-new transformations. Then do the
“man page” change. Also drop the faulty admonission change.

See the notes on the patches for details.

[1/2] doc: replace git config --list/-l with `list`
[2/2] doc: gitcvs-migration: rephrase “man page”

 Documentation/git-var.adoc              | 2 +-
 Documentation/gitcvs-migration.adoc     | 3 +--
 Documentation/gitprotocol-v2.adoc       | 2 +-
 Documentation/gittutorial.adoc          | 2 +-
 Documentation/technical/api-trace2.adoc | 2 +-
 Documentation/user-manual.adoc          | 2 +-
 6 files changed, 6 insertions(+), 7 deletions(-)

Interdiff against v1:
diff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc
index 98f4dc1a479..697c10adedc 100644
--- a/Documentation/git-var.adoc
+++ b/Documentation/git-var.adoc
@@ -21,9 +21,8 @@ OPTIONS
 `-l`::
 	Display the logical variables. In addition, all the
 	variables of the Git configuration file .git/config are listed
-	as well.
-+
-WARNING: Deprecated in favor of `git config list`.
+	as well. (However, the configuration variables listing functionality
+	is deprecated in favor of `git config list`.)
 
 EXAMPLES
 --------

base-commit: 67ad42147a7acc2af6074753ebd03d904476118f
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* [PATCH v2 1/2] doc: replace git config --list/-l with `list`
  2026-04-05 10:31 ` [PATCH v2 0/2] doc: replace mentions of deprecated git config --list kristofferhaugsbakk
@ 2026-04-05 10:31   ` kristofferhaugsbakk
  2026-04-05 10:32   ` [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page” kristofferhaugsbakk
  1 sibling, 0 replies; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-04-05 10:31 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Replace uses of `git config --list` (short or long) with the subcommand
`list` since `--list` is deprecated.

We will change the “man page” phrasing in gitcvs-migration(7) in the
next commit, since we are already visiting that sentence. But note
that we leave the “man page” phrasing in the sentence that we touch in
gittutorial(7) since it’s a tutorial and not a manual page. We can be
more wordy in a tutorial context.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---

Notes (series):
    v2: Now do all the deprecated --list/-l changes in one step
    v1: (was spread over the three patches)

 Documentation/git-var.adoc              | 2 +-
 Documentation/gitcvs-migration.adoc     | 2 +-
 Documentation/gitprotocol-v2.adoc       | 2 +-
 Documentation/gittutorial.adoc          | 2 +-
 Documentation/technical/api-trace2.adoc | 2 +-
 Documentation/user-manual.adoc          | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/git-var.adoc b/Documentation/git-var.adoc
index b606c2d6499..697c10adedc 100644
--- a/Documentation/git-var.adoc
+++ b/Documentation/git-var.adoc
@@ -22,7 +22,7 @@ OPTIONS
 	Display the logical variables. In addition, all the
 	variables of the Git configuration file .git/config are listed
 	as well. (However, the configuration variables listing functionality
-	is deprecated in favor of `git config -l`.)
+	is deprecated in favor of `git config list`.)
 
 EXAMPLES
 --------
diff --git a/Documentation/gitcvs-migration.adoc b/Documentation/gitcvs-migration.adoc
index 1cd1283d0f8..2883834b714 100644
--- a/Documentation/gitcvs-migration.adoc
+++ b/Documentation/gitcvs-migration.adoc
@@ -49,7 +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 -l` and the linkgit:git-config[1] man
+command; see `git config list` and the linkgit:git-config[1] man
 page for details.
 ================================
 
diff --git a/Documentation/gitprotocol-v2.adoc b/Documentation/gitprotocol-v2.adoc
index c7db103299a..ec2562fb0a1 100644
--- a/Documentation/gitprotocol-v2.adoc
+++ b/Documentation/gitprotocol-v2.adoc
@@ -659,7 +659,7 @@ use by the client, MUST indicate prerequisites (in any) with standard
 applicable.
 +
 The advertised URI may alternatively contain a plaintext file that `git
-config --list` would accept (with the `--file` option). The key-value
+config list` would accept (with the `--file` option). The key-value
 pairs in this list are in the `bundle.*` namespace (see
 linkgit:git-config[1]).
 
diff --git a/Documentation/gittutorial.adoc b/Documentation/gittutorial.adoc
index f89ad30cf65..519b8d8be2c 100644
--- a/Documentation/gittutorial.adoc
+++ b/Documentation/gittutorial.adoc
@@ -432,7 +432,7 @@ bob$ git config --get remote.origin.url
 -------------------------------------
 
 (The complete configuration created by `git clone` is visible using
-`git config -l`, and the linkgit:git-config[1] man page
+`git config list`, and the linkgit:git-config[1] man page
 explains the meaning of each option.)
 
 Git also keeps a pristine copy of Alice's `master` branch under the
diff --git a/Documentation/technical/api-trace2.adoc b/Documentation/technical/api-trace2.adoc
index cf493dae03f..918e517c2e6 100644
--- a/Documentation/technical/api-trace2.adoc
+++ b/Documentation/technical/api-trace2.adoc
@@ -1253,7 +1253,7 @@ it.
 $ git config --system color.ui never
 $ git config --global color.ui always
 $ git config --local color.ui auto
-$ git config --list --show-scope | grep 'color.ui'
+$ git config list --show-scope | grep 'color.ui'
 system  color.ui=never
 global  color.ui=always
 local   color.ui=auto
diff --git a/Documentation/user-manual.adoc b/Documentation/user-manual.adoc
index 76969871176..3cd94c7afa1 100644
--- a/Documentation/user-manual.adoc
+++ b/Documentation/user-manual.adoc
@@ -2865,7 +2865,7 @@ stored in Git configuration variables, which you can see using
 linkgit:git-config[1]:
 
 -------------------------------------------------
-$ git config -l
+$ git config list
 core.repositoryformatversion=0
 core.filemode=true
 core.logallrefupdates=true
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page”
  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   ` kristofferhaugsbakk
  2026-04-06 17:04     ` Junio C Hamano
  1 sibling, 1 reply; 13+ messages in thread
From: kristofferhaugsbakk @ 2026-04-05 10:32 UTC (permalink / raw)
  To: git; +Cc: Kristoffer Haugsbakk

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”.

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)”).

† 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
-- 
2.53.0.32.gf6228eaf9cc


^ permalink raw reply related	[flat|nested] 13+ messages in thread

* Re: [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page”
  2026-04-05 10:32   ` [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page” kristofferhaugsbakk
@ 2026-04-06 17:04     ` Junio C Hamano
  0 siblings, 0 replies; 13+ messages in thread
From: Junio C Hamano @ 2026-04-06 17:04 UTC (permalink / raw)
  To: kristofferhaugsbakk; +Cc: git, Kristoffer Haugsbakk

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

^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2026-04-06 17:04 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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 is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox