From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Martin Ågren" <martin.agren@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>,
"Jeff King" <peff@peff.net>, "Junio C Hamano" <gitster@pobox.com>,
"brian m . carlson" <sandals@crustytoothpaste.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 20/23] doc: asciidoctor: add hack to improve links
Date: Mon, 21 Jun 2021 11:31:07 -0500 [thread overview]
Message-ID: <20210621163110.1074145-21-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210621163110.1074145-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 7561973df6..914e6f64c8 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -10,6 +10,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.32.0
next prev parent reply other threads:[~2021-06-21 16:59 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-21 16:30 [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Felipe Contreras
2021-06-21 16:30 ` [PATCH 01/23] doc: remove GNU troff workaround Felipe Contreras
2021-06-21 16:30 ` [PATCH 02/23] doc: use --stringparam in xmlto Felipe Contreras
2021-06-21 16:30 ` [PATCH 03/23] doc: simplify version passing Felipe Contreras
2021-06-21 16:30 ` [PATCH 04/23] doc: asciidoc: remove unnecessary attribute Felipe Contreras
2021-06-21 16:30 ` [PATCH 05/23] doc: asciidoctor: remove unnecessary require Felipe Contreras
2021-06-21 16:30 ` [PATCH 06/23] doc: asciidoctor: remove cruft Felipe Contreras
2021-06-21 16:30 ` [PATCH 07/23] doc: asciidoctor: reorganize extensions Felipe Contreras
2021-06-21 16:30 ` [PATCH 08/23] doc: asciidoctor: use html-prefix only for html Felipe Contreras
2021-06-21 16:30 ` [PATCH 09/23] doc: asciidoctor: refactor macro registration Felipe Contreras
2021-06-21 16:30 ` [PATCH 10/23] doc: asciidoctor: improve string handling Felipe Contreras
2021-06-21 16:30 ` [PATCH 11/23] doc: asciidoctor: split the format from the code Felipe Contreras
2021-06-21 16:30 ` [PATCH 12/23] doc: asciidoctor: specify name of our group Felipe Contreras
2021-06-21 16:31 ` [PATCH 13/23] doc: doc-diff: set docdate manually Felipe Contreras
2021-06-21 16:31 ` [PATCH 14/23] doc-diff: drop --cut-footer switch Felipe Contreras
2021-06-21 16:31 ` [PATCH 15/23] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-06-22 5:23 ` Bagas Sanjaya
2021-06-23 1:35 ` Felipe Contreras
2021-06-21 16:31 ` [PATCH 16/23] doc-diff: support asciidoctor man pages Felipe Contreras
2021-06-21 16:31 ` [PATCH 17/23] doc: asciidoctor: add linkgit macros in " Felipe Contreras
2021-06-21 16:31 ` [PATCH 18/23] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-06-21 16:31 ` [PATCH 19/23] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-06-21 16:31 ` Felipe Contreras [this message]
2021-06-21 16:31 ` [PATCH 21/23] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-06-21 16:31 ` [PATCH 22/23] doc: asciidoctor: cleanup man page hack Felipe Contreras
2021-06-21 16:31 ` [PATCH 23/23] doc: asciidoctor: add hack for old versions Felipe Contreras
2021-06-22 5:35 ` [PATCH 00/23] doc: cleanups and asciidoctor direct man pages Bagas Sanjaya
2021-06-23 1:37 ` 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=20210621163110.1074145-21-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--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).