All of lore.kernel.org
 help / color / mirror / Atom feed
From: Michael J Gruber <git@grubix.eu>
To: git@vger.kernel.org
Subject: [PATCH] config: correct log.showRoot description
Date: Tue, 14 Jun 2022 18:14:22 +0200	[thread overview]
Message-ID: <b7aa801c3995fffdce37d90adba9253485b616e3.1655223201.git.git@grubix.eu> (raw)

The current description is misleading because it fits a "default false"
setting whereas the default is "true" (as mentioned).

Instead, craft the wording in `config/log.txt` analogous to the one in
`git-log.txt`.

Note that the wording is not exactly the same, e.g. because
`config/log.txt` wants to link to man pages and man pages want to refer
to command options. Otherwise, includes would be the easy route to
consistency here.

Signed-off-by: Michael J Gruber <git@grubix.eu>
---
 Documentation/config/log.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt
index 456eb07800..b210f24cca 100644
--- a/Documentation/config/log.txt
+++ b/Documentation/config/log.txt
@@ -40,10 +40,10 @@ log.graphColors::
 	history lines in `git log --graph`.
 
 log.showRoot::
-	If true, the initial commit will be shown as a big creation event.
-	This is equivalent to a diff against an empty tree.
-	Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
-	normally hide the root commit will now show it. True by default.
+	If `false`, tools like linkgit:git-log[1] or linkgit:git-whatchanged[1]
+	will not treat the initial commit as a big creation event.  Any root
+	commits in `git log -p` output would be shown without a diff attached.
+	The default is `true`.
 
 log.showSignature::
 	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
-- 
2.37.0.rc0.107.g7a7be657e7


             reply	other threads:[~2022-06-14 16:15 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-14 16:14 Michael J Gruber [this message]
2022-06-15  1:50 ` [PATCH] config: correct log.showRoot description Taylor Blau

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=b7aa801c3995fffdce37d90adba9253485b616e3.1655223201.git.git@grubix.eu \
    --to=git@grubix.eu \
    --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 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.