[PATCH 08/11] doc: asciidoctor: add hack for xrefs
From: Felipe Contreras <hidden>
Date: 2021-05-14 12:15:16
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
The docbook manpage stylesheets convert cross-references with format the
'section called “%t”'. I personally prefer the asciidoctor version, but
for now add a hack to minimize the diff.
Thanks to the extensibility of Ruby we can override corresponding method
in the man page converter.
This fixes doc-diffs like:
--worktree-attributes
Look for attributes in .gitattributes files in the working tree as
- well (see the section called “ATTRIBUTES”).
+ well (see ATTRIBUTES).
This can easily be removed later once we are confortable with the
asciidoctor version.
Signed-off-by: Felipe Contreras <redacted>
---
Documentation/asciidoctor-extensions.rb | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index 11937c2c1d..b2bbb318ad 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb@@ -1,5 +1,22 @@ require 'asciidoctor' require 'asciidoctor/extensions' +require 'asciidoctor/converter/manpage' + +module Asciidoctor + class Converter::ManPageConverter + alias orig_convert_inline_anchor convert_inline_anchor + def convert_inline_anchor(node) + case node.type + when :xref + return node.text if node.text + refid = node.attributes['refid'] + 'the section called “%s”' % refid.gsub('_', ' ') + else + orig_convert_inline_anchor(node) + end + end + end +end module Git module Documentation
--
2.31.1