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 09/11] doc: asciidoctor: add hack to improve links
Date: Fri, 14 May 2021 07:14:33 -0500 [thread overview]
Message-ID: <20210514121435.504423-10-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210514121435.504423-1-felipe.contreras@gmail.com>
The way asciidoctor handles links is very primitive compared to docbook.
Links are simply presented in the format "#{text} <#{target}>", which
may not be all that bad for the future, but pollutes the doc-diff.
By adding another modification to convert_inline_anchor() we can present
links in a form very similar to docbook, diminishing the doc-diff.
This significantly reduces the doc-diff:
From:
abysmal performance). These safety and performance issues cannot be
backward compatibly fixed and as such, its use is not recommended.
Please use an alternative history filtering tool such as git
- filter-repo[1]. If you still need to use git filter-branch, please
- carefully read the section called “SAFETY” (and the section called
- “PERFORMANCE”) to learn about the land mines of filter-branch, and then
- vigilantly avoid as many of the hazards listed there as reasonably
- possible.
+ <https://github.com/newren/git-filter-repo/> filter-repo" . If you
+ still need to use git filter-branch, please carefully read the section
+ called “SAFETY” (and the section called “PERFORMANCE”) to learn about
+ the land mines of filter-branch, and then vigilantly avoid as many of
+ the hazards listed there as reasonably possible.
-NOTES
- 1. git filter-repo
- https://github.com/newren/git-filter-repo/
-
- 2. filter-lamely
- https://github.com/newren/git-filter-repo/blob/master/contrib/filter-repo-demos/filter-lamely
-
To:
NOTES
- 1. git filter-repo
+ [1] git filter-repo
https://github.com/newren/git-filter-repo/
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
Documentation/asciidoctor-extensions.rb | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index b2bbb318ad..42133ee6c3 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -11,6 +11,19 @@ module Asciidoctor
return node.text if node.text
refid = node.attributes['refid']
'the section called “%s”' % refid.gsub('_', ' ')
+ when :link
+ return node.target if node.text == node.target
+ doc = node.document
+
+ footnote = doc.footnotes.find { |e| e.id == node.target }
+ if !footnote
+ footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, node.target]
+ index = doc.counter('footnote-number')
+ footnote = Document::Footnote.new(index, node.target, footnote_text)
+ doc.register(:footnotes, footnote)
+ end
+
+ "\e\\fB%s\e\\fR[%d]" % [node.text, footnote.index]
else
orig_convert_inline_anchor(node)
end
--
2.31.1
next prev parent reply other threads:[~2021-05-14 12:16 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 ` [PATCH 08/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-14 12:14 ` Felipe Contreras [this message]
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-10-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).