From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Jeff King" <peff@peff.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 08/11] doc: asciidoctor: add hack for xrefs
Date: Fri, 14 May 2021 07:14:32 -0500 [thread overview]
Message-ID: <20210514121435.504423-9-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com>
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 <felipe.contreras@gmail.com>
---
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
next prev parent reply other threads:[~2021-05-14 12:15 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-14 12:14 [PATCH 00/11] doc: asciidoctor: direct man page creation and fixes Felipe Contreras
2021-05-14 12:14 ` [PATCH 01/11] doc: allow the user to provide ASCIIDOC_EXTRA Felipe Contreras
2021-05-15 9:32 ` Jeff King
2021-05-15 9:39 ` Jeff King
2021-05-15 12:13 ` Felipe Contreras
2021-05-17 8:57 ` Jeff King
2021-05-17 10:53 ` Felipe Contreras
2021-05-17 11:39 ` Jeff King
2021-05-17 16:50 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 02/11] doc: doc-diff: allow more than one flag Felipe Contreras
2021-05-15 9:37 ` Jeff King
2021-05-15 12:11 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 03/11] doc: doc-diff: set docdate manually Felipe Contreras
2021-05-14 15:43 ` Martin Ågren
2021-05-14 20:33 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 04/11] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-05-14 15:38 ` Martin Ågren
2021-05-14 20:26 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 05/11] doc: asciidoctor: add linkgit macros in man pages Felipe Contreras
2021-05-14 12:14 ` [PATCH 06/11] doc: join mansource and manversion Felipe Contreras
2021-05-14 12:14 ` [PATCH 07/11] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-05-14 12:14 ` Felipe Contreras [this message]
2021-05-14 12:14 ` [PATCH 09/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-14 12:14 ` [PATCH 10/11] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-05-14 12:14 ` [PATCH 11/11] doc: asciidoctor: cleanup man page hack Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210514121435.504423-9-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.com \
--cc=peff@peff.net \
--cc=sandals@crustytoothpaste.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).