mbox series

[0/2] documentation fixes for 2.48.0

Message ID cover.1735903029.git.martin.agren@gmail.com (mailing list archive)
Headers show
Series documentation fixes for 2.48.0 | expand

Message

Martin Ågren Jan. 3, 2025, 11:33 a.m. UTC 
These two patches fix some misrenderings of the built documentation,
introduced during the 2.48 cycle. As usual, the exact current behaviors
(symptoms) differ a bit between AsciiDoc and Asciidoctor.

Martin

Martin Ågren (2):
  git.txt: fix heading line of tildes
  gitcli.txt: typeset pathnames as monospace

 Documentation/git.txt    | 2 +-
 Documentation/gitcli.txt | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Eric Sunshine Jan. 3, 2025, 11:39 a.m. UTC | #1 
On Fri, Jan 3, 2025 at 6:34 AM Martin Ågren <martin.agren@gmail.com> wrote:
> These two patches fix some misrenderings of the built documentation,
> introduced during the 2.48 cycle. As usual, the exact current behaviors
> (symptoms) differ a bit between AsciiDoc and Asciidoctor.

Both patches make sense. Out of curiosity, how are you discovering
these problems? Are you, for instance, running doc-diff and manually
scanning the output?
Martin Ågren Jan. 3, 2025, 11:59 a.m. UTC | #2 
On Fri, 3 Jan 2025 at 12:39, Eric Sunshine <sunshine@sunshineco.com> wrote:
>
> On Fri, Jan 3, 2025 at 6:34 AM Martin Ågren <martin.agren@gmail.com> wrote:
> > These two patches fix some misrenderings of the built documentation,
> > introduced during the 2.48 cycle. As usual, the exact current behaviors
> > (symptoms) differ a bit between AsciiDoc and Asciidoctor.
>
> Both patches make sense. Out of curiosity, how are you discovering
> these problems? Are you, for instance, running doc-diff and manually
> scanning the output?

Yes, exactly. Something like

  ./doc-diff v2.47.0 v2.48.0-rc1

is a nice way of finding out what's new. Occasionally, some oddity like
these stick out.

(The diff can easily look huge, but often several pages contain the same
content, so the 2nd/3rd/4th/... instance of a particular diff can be
skipped. Inclusion of diff-options.txt would be the typical example.)

Martin
Junio C Hamano Jan. 3, 2025, 4:21 p.m. UTC | #3 
Martin Ågren <martin.agren@gmail.com> writes:

> These two patches fix some misrenderings of the built documentation,
> introduced during the 2.48 cycle. As usual, the exact current behaviors
> (symptoms) differ a bit between AsciiDoc and Asciidoctor.

Thanks.