Skip to content

Commit

Permalink
doc: git-clone fix discrepancy between asciidoc and asciidoctor
Browse files Browse the repository at this point in the history
Asciidoc.py does not have the concept of generalized roles, whereas
asciidoctor interprets [foo]`blah` as blah with role foo in the
synopsis, making in effect foo disappear in the output. Note that
square brackets not directly followed by an inline markup do not
define a role, which is why we do not have the issue on other parts of
the documentation.

In order to get a consistant result across asciidoctor and
asciidoc.py, the hack is to use the {empty} entity
to split the bracket part from the inline format part.

Signed-off-by: Jean-Noël Avila <[email protected]>
  • Loading branch information
jnavila committed Jul 20, 2024
1 parent a7dae3b commit 4a12bf6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Documentation/git-clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ SYNOPSIS
[`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]
[`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]
[`--dissociate`] [`--separate-git-dir` _<git-dir>_]
[`--depth` _<depth>_] [`--`[`no-`]`single-branch`] [`--no-tags`]
[++--recurse-submodules++[++=++__<pathspec>__]] [`--`[`no-`]`shallow-submodules`]
[`--`[`no-`]`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]`reject-shallow`]
[`--depth` _<depth>_] [`--`[`no-`]{empty}`single-branch`] [`--no-tags`]
[++--recurse-submodules++[++=++__<pathspec>__]] [++--++[++no-++]{empty}++shallow-submodules++]
[`--`[`no-`]{empty}`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]{empty}`reject-shallow`]
[++--filter=++__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_
[_<directory>_]

Expand Down

0 comments on commit 4a12bf6

Please sign in to comment.