Git development
 help / color / mirror / Atom feed
From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH v2 1/2] doc: replace git config --list/-l with `list`
Date: Sun,  5 Apr 2026 12:31:59 +0200	[thread overview]
Message-ID: <V2_doc_config_--list_replace_all.56a@msgid.xyz> (raw)
In-Reply-To: <V2_CV_doc_deprecation_config_--list.569@msgid.xyz>

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


  reply	other threads:[~2026-04-05 10:33 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   ` kristofferhaugsbakk [this message]
2026-04-05 10:32   ` [PATCH v2 2/2] doc: gitcvs-migration: rephrase “man page” kristofferhaugsbakk
2026-04-06 17:04     ` 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=V2_doc_config_--list_replace_all.56a@msgid.xyz \
    --to=kristofferhaugsbakk@fastmail.com \
    --cc=code@khaugsbakk.name \
    --cc=git@vger.kernel.org \
    /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