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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxx>
---

 * 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





[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux