diff mbox series

[RFC,3/3] doc: asciidoc.py workarounds for doc guideline

Message ID 20230405125453.49674-4-felipe.contreras@gmail.com (mailing list archive)
State New, archived
Headers show
Series doc: document for our use of legacy asciidoc.py | expand

Commit Message

Felipe Contreras April 5, 2023, 12:54 p.m. UTC 
asciidoc.py for some reason can't handle one URL, and doesn't understand
listings inside listings (of obvious different levels).

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/DocumentationGuideline.adoc | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/DocumentationGuideline.adoc b/Documentation/DocumentationGuideline.adoc
index 8f1300f898..a581c47f05 100644
--- a/Documentation/DocumentationGuideline.adoc
+++ b/Documentation/DocumentationGuideline.adoc
@@ -4,7 +4,7 @@ 
 :3: https://docs.asciidoctor.org/asciidoc/latest/text/troubleshoot-unconstrained-formatting/
 :4: https://docs.asciidoctor.org/asciidoc/latest/text/literal-monospace/
 :5: https://lore.kernel.org/git/pull.1304.git.git.1659387885711.gitgitgadget@gmail.com/[[PATCH\\] Documentation/git-reflog: remove unneeded \ from \{]
-:6: https://lore.kernel.org/git/CABPp-BEEDS%3Dv7ouOKts83OFMxDq%3DF0TKO1XvHEbnmXJ+Z1WELA@mail.gmail.com/[Re: [PATCH\\] git-merge-tree.txt: replace spurious HTML entity]
+:6: https://lore.kernel.org/git/CAMP44s3Kqyrdavp1OiozNbA7k4EHCj0KiQq4d2Dyg_KZSEAUuQ@mail.gmail.com/[Re: [PATCH\\] git-merge-tree.txt: replace spurious HTML entity]
 
 Documents shall follow the AsciiDoc format, a simple markup language specified in the {1}[AsciiDoc Language
 Documentation].
@@ -78,12 +78,13 @@  Renders as:
 
 Often you'll want to include example code, for that you can use listing blocks:
 
------
+[listing]
+....
 ----
 __attribute__((format (printf, 2, 3)))
 void fprintf_or_die(FILE *, const char *fmt, ...);
 ----
------
+....
 
 Renders as: