git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 06/11] doc: add man pages workaround for asciidoctor

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
May 21, 2021, 22:44 UTC
Message-ID
<20210521224452.530852-7-felipe.contreras@gmail.com>
In-Reply-To
<20210521224452.530852-1-felipe.contreras@gmail.com>

Currently asciidoctor doesn't convert number character references (&#xx;) correctly for man pages.

This hack fixes the issue with minimum changes elsewhere so it's easy to remove when fixed.

Fixes doc-diffs like:
            so line count cannot be shown) and there is no difference between
            indexed copy and the working tree version (if the working tree
            version were also different, binary would have been shown in place
-           of nothing). The other file, git-add--interactive.perl, has 403
-           lines added and 35 lines deleted if you commit what is in the
-           index, but working tree file has further modifications (one
+           of nothing). The other file, git-add&#x2d;&#x2d;interactive.perl,
+           has 403 lines added and 35 lines deleted if you commit what is in
+           the index, but working tree file has further modifications (one
            addition and one deletion).
https://github.com/asciidoctor/asciidoctor/issues/4059
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/asciidoctor-extensions.rb | 6 ++++++
 1 file changed, 6 insertions(+)
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index 6c4153f628..954acb3e7d 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -4,6 +4,12 @@ Asciidoctor::Extensions.register :git do
 
   doc = document
 
+  # Override attributes for man pages.
+  # https://github.com/asciidoctor/asciidoctor/issues/4059
+  if doc.backend == 'manpage'
+    doc.attributes.merge!({ 'litdd' => '\--', 'plus' => '+' })
+  end
+
   inline_macro :linkgit do
     if doc.doctype == 'book'
       format = '<ulink url="%1$s.html">%1$s(%2$s)</ulink>'
-- 
2.32.0.rc0
Previous: Felipe ContrerasNext: Felipe Contreras
Message 11 of 17 in “doc: asciidoctor: direct man page creation and fixes”
  1. 00/11 doc: asciidoctor: direct man page creation and fixesFelipe Contreras, May 21, 2021
  2. 01/11 doc: doc-diff: set docdate manuallyFelipe Contreras, May 21, 2021
  3. Bagas SanjayaMay 22, 2021
  4. Felipe ContrerasMay 22, 2021
  5. 02/11 doc-diff: drop --cut-footer switchFelipe Contreras, May 21, 2021
  6. 03/11 doc: use asciidoctor to build man pages directlyFelipe Contreras, May 21, 2021
  7. Felipe ContrerasJun 2, 2021
  8. 04/11 doc-diff: support asciidoctor man pagesFelipe Contreras, May 21, 2021
  9. Felipe ContrerasMay 21, 2021
  10. 05/11 doc: asciidoctor: add linkgit macros in man pagesFelipe Contreras, May 21, 2021
  11. 06/11 doc: add man pages workaround for asciidoctorFelipe Contreras, May 21, 2021
  12. 07/11 doc: asciidoctor: add hack for xrefsFelipe Contreras, May 21, 2021
  13. 08/11 doc: asciidoctor: add hack to improve linksFelipe Contreras, May 21, 2021
  14. 09/11 doc: asciidoctor: add support for baseurlFelipe Contreras, May 21, 2021
  15. 10/11 doc: asciidoctor: cleanup man page hackFelipe Contreras, May 21, 2021
  16. 11/11 doc: asciidoctor: add hack for old versionsFelipe Contreras, May 21, 2021
  17. Felipe ContrerasMay 21, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.