[PATCH] config: correct log.showRoot description

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

 



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




[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