| Message ID | b7aa801c3995fffdce37d90adba9253485b616e3.1655223201.git.git@grubix.eu (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | config: correct log.showRoot description | expand |
On Tue, Jun 14, 2022 at 06:14:22PM +0200, Michael J Gruber wrote: > 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`. This looks good to me. An alternative approach which would work to would be to replace "If `true`" with "When `true`". I have a vague preference towards the latter, since it explains what log.showRoot does, rather than what it does not do. But this works just as well, and I think that I'm splitting hairs anyways ;). Thanks, Taylor
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
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(-)