[PATCH 0/2] documentation fixes for 2.48.0

[PATCH 0/2] documentation fixes for 2.48.0

[Martin Ågren]

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(-)

-- 
2.48.0.rc1.241.g6c04ab211c

[PATCH 1/2] git.txt: fix heading line of tildes

[Martin Ågren]

The two-line heading added in 8525e92886 (Document HOME environment
variable, 2024-12-09) uses too many tilde characters, so the heading
isn't detected as such. Both AsciiDoc and Asciidoctor end up
misrendering this in different ways.

Use the correct number of tilde characters to fix this.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/git.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 81498393af..e89a91dd0d 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -478,7 +478,7 @@ their values the same way as Boolean valued configuration variables, e.g.
 Here are the variables:
 
 System
-~~~~~~~~~~~~~~~~~~
+~~~~~~
 `HOME`::
 	Specifies the path to the user's home directory. On Windows, if
 	unset, Git will set a process environment variable equal to:
-- 
2.48.0.rc1.241.g6c04ab211c

[PATCH 2/2] gitcli.txt: typeset pathnames as monospace

[Martin Ågren]

Commit 1bc1e94091 (doc: option value may be separate for valid reasons,
2024-11-25) added a paragraph discussing tilde-expansion of, e.g.,
~/directory/file.

The tilde character has a special meaning to asciidoc tools. In this
particular case, AsciiDoc matches up the two tildes in "e.g.
~/directory/file or ~u/d/f" and sets the text between them using
subscript. In the manpage, where subscripting is not possible, this
renders as "e.g.  /directory/file oru/d/f".

These paths are literal values, which our coding guidelines want typeset
as verbatim using backticks. Do that. One effect of this is indeed that
the asciidoc tools stop interpreting tilde and other special characters.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 Documentation/gitcli.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index bd62cbd043..fcd86d2eee 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -91,7 +91,7 @@ scripting Git:
    written in the 'stuck' form.
 
  * Despite the above suggestion, when Arg is a path relative to the
-   home directory of a user, e.g. ~/directory/file or ~u/d/f, you
+   home directory of a user, e.g. `~/directory/file` or `~u/d/f`, you
    may want to use the separate form, e.g. `git foo --file ~/mine`,
    not `git foo --file=~/mine`.  The shell will expand `~/` in the
    former to your home directory, but most shells keep the tilde in
-- 
2.48.0.rc1.241.g6c04ab211c

Re: [PATCH 0/2] documentation fixes for 2.48.0

[Eric Sunshine]

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?

Re: [PATCH 0/2] documentation fixes for 2.48.0

[Martin Ågren]

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

Re: [PATCH 0/2] documentation fixes for 2.48.0

[Junio C Hamano]

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.