git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH] blame: do not mention obvious default configuration values
Date: Wed, 22 May 2024 11:44:37 -0700	[thread overview]
Message-ID: <xmqqpltd4rfu.fsf@gitster.g> (raw)

While it helps to mention what the default behaviour is when a
variable is unconfigured, when there are more than true or false
choices for the variable (e.g. "defaults to never, among possible
choices never/local/remote/always"), or if the default behaviour is
as if the unconfigured variable were set to true the knob is purely
to opt out of it ("Porcelain 'git diff' refreshes the index, but
diff.autoRefreshIndex can be set to false to opt out of it"), it
feels like it adds unnecesary noise to say "defaults to off" for a
configuration variable that is clearly a Boolean.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

 * I am somewhat hesitant to use a phrase that implies that there is
   some "default value" for any configuration variable.  Saying "The
   default value for the configuration variable X is Y" misleads
   readers to expect that "git config -l" would show X=Y when the
   user hasn't configured X at all.

   It is just the feature controlled by the configuration variable
   works exactly as if the configuration variable is set to that
   "default value", instead of left unconfigured.

   But that is a separate issue, and is totally outside the scope of
   this change.

 Documentation/config/blame.txt | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/config/blame.txt b/Documentation/config/blame.txt
index 4d047c1790..36f965484c 100644
--- a/Documentation/config/blame.txt
+++ b/Documentation/config/blame.txt
@@ -1,6 +1,6 @@
 blame.blankBoundary::
 	Show blank commit object name for boundary commits in
-	linkgit:git-blame[1]. This option defaults to false.
+	linkgit:git-blame[1].
 
 blame.coloring::
 	This determines the coloring scheme to be applied to blame
@@ -14,11 +14,9 @@ blame.date::
 
 blame.showEmail::
 	Show the author email instead of author name in linkgit:git-blame[1].
-	This option defaults to false.
 
 blame.showRoot::
 	Do not treat root commits as boundaries in linkgit:git-blame[1].
-	This option defaults to false.
 
 blame.ignoreRevsFile::
 	Ignore revisions listed in the file, one unabbreviated object name per
-- 
2.45.1-216-g4365c6fcf9


             reply	other threads:[~2024-05-22 18:44 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-22 18:44 Junio C Hamano [this message]
2024-05-22 19:13 ` [PATCH] blame: do not mention obvious default configuration values Dragan Simic
2024-05-22 19:19   ` Eric Sunshine
2024-05-23  9:08     ` Jeff King

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=xmqqpltd4rfu.fsf@gitster.g \
    --to=gitster@pobox.com \
    --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;
as well as URLs for NNTP newsgroup(s).