# [PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph 12 messages from 2021-02-17 to 2021-02-19. Participants: Martin Ågren, Junio C Hamano, Chris Torek, Patrick Steinhardt, Ævar Arnfjörð Bjarmason. Thread: https://gitlist.dev/t/55164 ## Martin Ågren, 2021-02-17 19:56 Subject: [PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph Message-ID: <888eca4c3544864fbe222de43b50d4fa25700fea.1613590761.git.martin.agren@gmail.com> URL: https://gitlist.dev/e/888eca4c3544864fbe222de43b50d4fa25700fea.1613590761.git.martin.agren%40gmail.com In-Reply-To: ``` In git-log(1) -- but not in git-shortlog(1) or git-rev-list(1) -- we include a bonus paragraph in the description of `--first-parent`. But we forgot to add a lone "+" for a list continuation, and we shouldn't be indenting this second paragraph. As a result, we get a different indentation and the `backticks` render literally. Signed-off-by: Martin Ågren --- doc-diff: --- a/.../man/man1/git-log.1 +++ b/.../man/man1/git-log.1 @@ -264,8 +264,8 @@ OPTIONS time, and this option allows you to ignore the individual commits brought in to your history by such a merge. - This option also changes default diff format for merge commits - to `first-parent`, see `--diff-merges=first-parent` for details. + This option also changes default diff format for merge commits to + first-parent, see --diff-merges=first-parent for details. --not Reverses the meaning of the ^ prefix (or lack thereof) for all Documentation/rev-list-options.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 96cc89d157..2fa1629f1e 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -129,10 +129,10 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit). adjusting to updated upstream from time to time, and this option allows you to ignore the individual commits brought in to your history by such a merge. - ifdef::git-log[] - This option also changes default diff format for merge commits - to `first-parent`, see `--diff-merges=first-parent` for details. ++ +This option also changes default diff format for merge commits +to `first-parent`, see `--diff-merges=first-parent` for details. endif::git-log[] --not:: -- 2.30.0.284.gd98b1dd5ea ``` ## Martin Ågren, 2021-02-17 19:56 Subject: [PATCH 0/3] fix some doc rendering issues since v2.30.0 Message-ID: URL: https://gitlist.dev/e/cover.1613590761.git.martin.agren%40gmail.com ``` These three patches fix some rendering issues I came across in the output of ./doc-diff v2.30.0 master The original topics are so/log-diff-merge, ps/config-env-pairs and ab/mailmap. Martin Ågren (3): rev-list-options.txt: fix rendering of bonus paragraph git.txt: fix monospace rendering gitmailmap.txt: fix rendering of e-mail addresses Documentation/git.txt | 2 +- Documentation/gitmailmap.txt | 8 ++++---- Documentation/rev-list-options.txt | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) -- 2.30.0.284.gd98b1dd5ea ``` ## Martin Ågren, 2021-02-17 19:56 Subject: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: <97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6.1613590761.git.martin.agren@gmail.com> URL: https://gitlist.dev/e/97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6.1613590761.git.martin.agren%40gmail.com In-Reply-To: ``` When we write ``s with the "s" tucked on to the closing backtick, we end up rendering the backticks literally. Rephrase this sentence slightly to render this as monospace. Signed-off-by: Martin Ågren --- doc-diff: --- a/.../man/man1/git.1 +++ b/.../man/man1/git.1 @@ -77,8 +77,8 @@ OPTIONS setting the value to an empty string, instead the environment variable itself must be set to the empty string. It is an error if the does not exist in the environment. may not - contain an equals sign to avoid ambiguity with ``s which - contain one. + contain an equals sign to avoid ambiguity with containing + one. This is useful for cases where you want to pass transitory configuration options to git, but are doing so on OS’s where other Documentation/git.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git.txt b/Documentation/git.txt index d36e6fd482..3a9c44987f 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -88,7 +88,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config empty string, instead the environment variable itself must be set to the empty string. It is an error if the `` does not exist in the environment. `` may not contain an equals sign - to avoid ambiguity with ``s which contain one. + to avoid ambiguity with `` containing one. + This is useful for cases where you want to pass transitory configuration options to git, but are doing so on OS's where -- 2.30.0.284.gd98b1dd5ea ``` ## Martin Ågren, 2021-02-17 19:56 Subject: [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses Message-ID: URL: https://gitlist.dev/e/ee0422ac399daf43a7adcc2b662b50312da04631.1613590761.git.martin.agren%40gmail.com In-Reply-To: ``` Both AsciiDoc and Asciidoctor are eager to pick up the e-mail addresses in this document and turn them into references at the bottom of the manpage / clickable links. We don't really need that for these dummy addresses. Spell "@" as "@" to make them not do this. In the open block, we can instead avoid this by indenting the contents, similar to the earlier blocks. Fix a backtick which should have been a single quote mark. With all the quoting that is going on around here, this mistake trips up the parsing and rendering quite a bit. Before this commit, we have the same failure mode with AsciiDoc 8.6.10 and Asciidoctor 1.5.5, and this change makes both of them happy. Signed-off-by: Martin Ågren --- doc-diff: --- a/97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6-asciidoctor-cut-footer/home/martin/share/man/man5/gitmailmap.5 +++ b/ee0422ac399daf43a7adcc2b662b50312da04631-asciidoctor-cut-footer/home/martin/share/man/man5/gitmailmap.5 @@ -40,9 +40,9 @@ SYNTAX matching both the specified commit name and email address. Both E-Mails and names are matched case-insensitively. For example this - would also match the Commit Name above: + would also match the Commit Name above: - Proper Name CoMmIt NaMe + Proper Name CoMmIt NaMe EXAMPLES Your history contains commits by two authors, Jane and Joe, whose names @@ -62,11 +62,10 @@ EXAMPLES Jane Doe Jane Doe - Note that there’s no need to map the name for jane@laptop.(none) to + Note that there’s no need to map the name for to only correct the names. However, leaving the obviously broken - ' and '' E-Mails as-is is - usually not what you want. A `.mailmap file which also corrects those - is: + and E-Mails as-is is usually + not what you want. A .mailmap file which also corrects those is: Joe R. Developer Jane Doe @@ -93,13 +92,3 @@ SEE ALSO GIT Part of the git(1) suite - -NOTES - 1. commit@email.xx - mailto:commit@email.xx - - 2. proper@email.xx - mailto:proper@email.xx - - 3. CoMmIt@EmAiL.xX - mailto:CoMmIt@EmAiL.xX Documentation/gitmailmap.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt index 052209b33b..3fb39f801f 100644 --- a/Documentation/gitmailmap.txt +++ b/Documentation/gitmailmap.txt @@ -50,9 +50,9 @@ which allows mailmap to replace both the name and the email of a commit matching both the specified commit name and email address. Both E-Mails and names are matched case-insensitively. For example -this would also match the 'Commit Name ' above: +this would also match the 'Commit Name ' above: -- -Proper Name CoMmIt NaMe + Proper Name CoMmIt NaMe -- EXAMPLES @@ -79,9 +79,9 @@ Jane Doe Jane Doe ------------ -Note that there's no need to map the name for 'jane@laptop.(none)' to +Note that there's no need to map the name for '' to only correct the names. However, leaving the obviously broken -`' and '' E-Mails as-is is +'' and '' E-Mails as-is is usually not what you want. A `.mailmap` file which also corrects those is: -- 2.30.0.284.gd98b1dd5ea ``` ## Junio C Hamano, 2021-02-17 21:22 Subject: Re: [PATCH 0/3] fix some doc rendering issues since v2.30.0 Message-ID: URL: https://gitlist.dev/e/xmqqeehejsot.fsf%40gitster.g In-Reply-To: ``` Martin Ågren writes: > These three patches fix some rendering issues I came across in the > output of > > ./doc-diff v2.30.0 master > > The original topics are so/log-diff-merge, ps/config-env-pairs and > ab/mailmap. > > Martin Ågren (3): > rev-list-options.txt: fix rendering of bonus paragraph > git.txt: fix monospace rendering > gitmailmap.txt: fix rendering of e-mail addresses > > Documentation/git.txt | 2 +- > Documentation/gitmailmap.txt | 8 ++++---- > Documentation/rev-list-options.txt | 6 +++--- > 3 files changed, 8 insertions(+), 8 deletions(-) All of them look "obviously correct". Thanks. ``` ## Chris Torek, 2021-02-17 22:47 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/CAPx1GvdcFGmAi_zJ9H0%2B40uZw49qhTs8C_afnMMVj32EFJXqBQ%40mail.gmail.com In-Reply-To: <97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6.1613590761.git.martin.agren@gmail.com> ``` On Wed, Feb 17, 2021 at 1:21 PM Martin Ågren wrote: > > When we write ``s with the "s" tucked on to the closing backtick, > we end up rendering the backticks literally. Rephrase this sentence > slightly to render this as monospace. That seems fine, but one question (diff trimmed way down to make it clearer I hope): > + contain an equals sign to avoid ambiguity with containing > + to avoid ambiguity with `` containing one. One replacement drops the backquotes entirely. The other keeps them. Surely these two shouldn't be *different*...? Chris ``` ## Patrick Steinhardt, 2021-02-18 06:27 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/YC4I20bQ0jeNLO%2BM%40ncase In-Reply-To: <97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6.1613590761.git.martin.agren@gmail.com> ``` On Wed, Feb 17, 2021 at 08:56:05PM +0100, Martin Ågren wrote: > When we write ``s with the "s" tucked on to the closing backtick, > we end up rendering the backticks literally. Rephrase this sentence > slightly to render this as monospace. > > Signed-off-by: Martin Ågren > --- > doc-diff: > --- a/.../man/man1/git.1 > +++ b/.../man/man1/git.1 > @@ -77,8 +77,8 @@ OPTIONS > setting the value to an empty string, instead the environment > variable itself must be set to the empty string. It is an error if > the does not exist in the environment. may not > - contain an equals sign to avoid ambiguity with ``s which > - contain one. > + contain an equals sign to avoid ambiguity with containing > + one. Over here you're also dropping the backticks, while... > This is useful for cases where you want to pass transitory > configuration options to git, but are doing so on OS’s where other > Documentation/git.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/git.txt b/Documentation/git.txt > index d36e6fd482..3a9c44987f 100644 > --- a/Documentation/git.txt > +++ b/Documentation/git.txt > @@ -88,7 +88,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config > empty string, instead the environment variable itself must be > set to the empty string. It is an error if the `` does not exist > in the environment. `` may not contain an equals sign > - to avoid ambiguity with ``s which contain one. > + to avoid ambiguity with `` containing one. ... here you don't. Is this on purpose? Patrick > This is useful for cases where you want to pass transitory > configuration options to git, but are doing so on OS's where > -- > 2.30.0.284.gd98b1dd5ea > ``` ## Martin Ågren, 2021-02-18 06:28 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/CAN0heSoZJgdKHmWcm3BF2-eWtWMPvSf9YSsKuE7%2BPaBY4LMKtA%40mail.gmail.com In-Reply-To: ``` On Wed, 17 Feb 2021 at 23:47, Chris Torek wrote: > > On Wed, Feb 17, 2021 at 1:21 PM Martin Ågren wrote: > > > > When we write ``s with the "s" tucked on to the closing backtick, > > we end up rendering the backticks literally. Rephrase this sentence > > slightly to render this as monospace. > > That seems fine, but one question (diff trimmed way down to > make it clearer I hope): > > > + contain an equals sign to avoid ambiguity with containing > > > + to avoid ambiguity with `` containing one. > > One replacement drops the backquotes entirely. The other keeps > them. Surely these two shouldn't be *different*...? I included the output of our "doc-diff" script below the double-dash line. The patch applies just as fine anyway, but I did wonder if it would trip up human readers. :-/ Quoting my original, slightly less trimmed: On Wed, 17 Feb 2021 at 20:56, Martin Ågren wrote: > doc-diff: > --- a/.../man/man1/git.1 > +++ b/.../man/man1/git.1 > - contain an equals sign to avoid ambiguity with ``s which > - contain one. > + contain an equals sign to avoid ambiguity with containing > + one. So that's how the rendering is changed. From "oops, we rendered the backticks literally" to "we no longer do". (It's not clear from the doc-diff that they're rendered monospace/bold, but at least this is no longer obviously broken.) (Note the extra indentation of all of that. This is where one might place some commentary that one don't want to burden the commit message with, but which also isn't part of the actual diff. Now that this looks very much like a diff, I can see how it's confusing.) And that's because of this change to the actual sources: > diff --git a/Documentation/git.txt b/Documentation/git.txt > index d36e6fd482..3a9c44987f 100644 > --- a/Documentation/git.txt > +++ b/Documentation/git.txt > - to avoid ambiguity with ``s which contain one. > + to avoid ambiguity with `` containing one. I hope that clarifies it? It's a bit unfortunate that the misrendering is so similar to the source in the txt file. But I guess that's still better than some of those misrenderings where some cogwheel slips and everything spins out of control through the rest of the paragraph. Martin ``` ## Martin Ågren, 2021-02-18 06:32 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/CAN0heSqn%2Bb70tPJjigeKj4cDE%3DYW7vSDyZLrmP02qZd0tN8PCw%40mail.gmail.com In-Reply-To: ``` On Thu, 18 Feb 2021 at 07:27, Patrick Steinhardt wrote: > > On Wed, Feb 17, 2021 at 08:56:05PM +0100, Martin Ågren wrote: > > When we write ``s with the "s" tucked on to the closing backtick, > > we end up rendering the backticks literally. Rephrase this sentence > > slightly to render this as monospace. > > > > Signed-off-by: Martin Ågren > > --- > > doc-diff: > > --- a/.../man/man1/git.1 > > +++ b/.../man/man1/git.1 > > @@ -77,8 +77,8 @@ OPTIONS > > setting the value to an empty string, instead the environment > > variable itself must be set to the empty string. It is an error if > > the does not exist in the environment. may not > > - contain an equals sign to avoid ambiguity with ``s which > > - contain one. > > + contain an equals sign to avoid ambiguity with containing > > + one. > > Over here you're also dropping the backticks, while... > > > This is useful for cases where you want to pass transitory > > configuration options to git, but are doing so on OS’s where other > > Documentation/git.txt | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/Documentation/git.txt b/Documentation/git.txt > > index d36e6fd482..3a9c44987f 100644 > > --- a/Documentation/git.txt > > +++ b/Documentation/git.txt > > @@ -88,7 +88,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config > > empty string, instead the environment variable itself must be > > set to the empty string. It is an error if the `` does not exist > > in the environment. `` may not contain an equals sign > > - to avoid ambiguity with ``s which contain one. > > + to avoid ambiguity with `` containing one. > > ... here you don't. Is this on purpose? Your mail crossed with my response to Chris, who had the same question. I'd post a link to lore.kernel.org, but it seems my response hasn't reached it yet. The short answer is the first diff is an indented diff of the rendered manpages (our "doc-diff" script), whereas the second diff is the actual, to-be-applied diff. I thought it would be helpful to include the doc-diff, but it seems it just created more confusion than it avoided. I'll try to avoid that. :-) Thanks Martin ``` ## Ævar Arnfjörð Bjarmason, 2021-02-18 10:48 Subject: Re: [PATCH 3/3] gitmailmap.txt: fix rendering of e-mail addresses Message-ID: <87tuq98xd9.fsf@evledraar.gmail.com> URL: https://gitlist.dev/e/87tuq98xd9.fsf%40evledraar.gmail.com In-Reply-To: ``` On Wed, Feb 17 2021, Martin Ågren wrote: > Both AsciiDoc and Asciidoctor are eager to pick up the e-mail addresses > in this document and turn them into references at the bottom of the > manpage / clickable links. We don't really need that for these dummy > addresses. Spell "@" as "@" to make them not do this. In the open > block, we can instead avoid this by indenting the contents, similar to > the earlier blocks. > > Fix a backtick which should have been a single quote mark. With all the > quoting that is going on around here, this mistake trips up the parsing > and rendering quite a bit. > > Before this commit, we have the same failure mode with AsciiDoc 8.6.10 > and Asciidoctor 1.5.5, and this change makes both of them happy. THanks a lot for the fix & cleaning up my mess. This LGTM. ``` ## Junio C Hamano, 2021-02-18 18:51 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/xmqqim6pgqev.fsf%40gitster.g In-Reply-To: <97c686dd7ba1bbd1c0be6f7f61a3a033adf8adb6.1613590761.git.martin.agren@gmail.com> ``` Martin Ågren writes: > When we write ``s with the "s" tucked on to the closing backtick, > we end up rendering the backticks literally. Rephrase this sentence > slightly to render this as monospace. > > Signed-off-by: Martin Ågren > --- > doc-diff: > --- a/.../man/man1/git.1 > +++ b/.../man/man1/git.1 > @@ -77,8 +77,8 @@ OPTIONS > setting the value to an empty string, instead the environment > variable itself must be set to the empty string. It is an error if > the does not exist in the environment. may not > - contain an equals sign to avoid ambiguity with ``s which > - contain one. > + contain an equals sign to avoid ambiguity with containing > + one. > > This is useful for cases where you want to pass transitory > configuration options to git, but are doing so on OS’s where other > Documentation/git.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/git.txt b/Documentation/git.txt > index d36e6fd482..3a9c44987f 100644 > --- a/Documentation/git.txt > +++ b/Documentation/git.txt > @@ -88,7 +88,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config > empty string, instead the environment variable itself must be > set to the empty string. It is an error if the `` does not exist > in the environment. `` may not contain an equals sign > - to avoid ambiguity with ``s which contain one. > + to avoid ambiguity with `` containing one. > + > This is useful for cases where you want to pass transitory > configuration options to git, but are doing so on OS's where The "two" diffs may indeed be misleading. The patch only changes one source and the "supporting material" is not something that we need to use on the source file---it is only showing the change in the output. I did appreciate the inclusion of doc-diff myself, but it seems that it confused Chris and Patrick. I doubt that it is an improvement to omit doc-diff. We may want to find a way to make it easier for the readers to tell which part is the patch to be applied and which part is not in similar changes we discuss on the list in the future, and apparently, a one column indentation alone was not quite sufficient in this case. Replacing "doc-diff:" label and patch header lines up to the hunk header with a prose to explain what the intended diff is may have helped, e.g. ... slightly to render this as monospace. Signed-off-by: A U Thor --- The rendered output changes like the following excerpt from doc-diff output. .... may not - contain an equals sign to avoid ambiguity with ``s which - contain one. + contain an equals sign to avoid ambiguity with containing + one. You can see that backquotes are gone, even though you unfortunately cannot see how is typeset (it is in monospace--trust me ;-). Documentation/git.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.... index .... --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ ... ``` ## Martin Ågren, 2021-02-19 06:33 Subject: Re: [PATCH 2/3] git.txt: fix monospace rendering Message-ID: URL: https://gitlist.dev/e/CAN0heSp_Jc6x-xNqt4uSPHi17GwuVtcOEStxe66MAD-6h1cyhg%40mail.gmail.com In-Reply-To: ``` On Thu, 18 Feb 2021 at 19:51, Junio C Hamano wrote: > > The "two" diffs may indeed be misleading. > > The patch only changes one source and the "supporting material" is > not something that we need to use on the source file---it is only > showing the change in the output. > > I did appreciate the inclusion of doc-diff myself, but it seems that > it confused Chris and Patrick. I doubt that it is an improvement to > omit doc-diff. We may want to find a way to make it easier for the > readers to tell which part is the patch to be applied and which part > is not in similar changes we discuss on the list in the future, and > apparently, a one column indentation alone was not quite sufficient > in this case. Replacing "doc-diff:" label and patch header lines up > to the hunk header with a prose to explain what the intended diff is > may have helped, e.g. Glad to know you found the included doc-diff useful. Thanks for the suggestion on how to present it. Next time I'll try wrapping the doc-diff in English prose to make it stand out more. The "doc-diff:" I used now was definitely a bit too subtle. Thanks Martin ```