git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] blame: do not mention obvious default configuration values

From
Junio C Hamano <gitster@pobox.com>
Date
May 22, 2024, 18:44 UTC
Message-ID
<xmqqpltd4rfu.fsf@gitster.g>

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
Next: Dragan Simic
Message 1 of 4 in “blame: do not mention obvious default configuration values”
  1. blame: do not mention obvious default configuration valuesJunio C Hamano, May 22, 2024
  2. Dragan SimicMay 22, 2024
  3. Eric SunshineMay 22, 2024
  4. Jeff KingMay 23, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.