git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
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 v2 09/11] doc: asciidoctor: add support for baseurl
Date: Fri, 21 May 2021 17:44:50 -0500	[thread overview]
Message-ID: <20210521224452.530852-10-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210521224452.530852-1-felipe.contreras@gmail.com>

So that we can present relative links correctly.

Reduces the doc-diff:

   NOTES
  -        1. “Understanding history: What is a branch?”
  -           file:///$HOME/share/doc/git-doc/user-manual.html#what-is-a-branch
  +       [1]    “Understanding history: What is a branch?”
  +              user-manual.html#what-is-a-branch

   NOTES
  -        1. “Understanding history: What is a branch?”
  +       [1]    “Understanding history: What is a branch?”
                 file:///$HOME/share/doc/git-doc/user-manual.html#what-is-a-branch

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/Makefile                  | 1 +
 Documentation/asciidoctor-extensions.rb | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 0c654f4ec9..c28c49dd7a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -185,6 +185,7 @@ ASCIIDOC_DOCBOOK = docbook5
 ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
 ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
 ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
+ASCIIDOC_EXTRA += -abaseurl='$(MAN_BASE_URL)'
 ASCIIDOC_DEPS = asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
 DBLATEX_COMMON =
 XMLTO_EXTRA += --skip-validation
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index 914e6f64c8..8856f2febd 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -16,7 +16,9 @@ module Asciidoctor
 
         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]
+          target = node.target
+          target = doc.attributes['baseurl'] + target unless target.include? ':'
+          footnote_text = "%s\n\e.RS\n\e\\%%%s\n\e.RE" % [node.text, target]
           index = doc.counter('footnote-number')
           footnote = Document::Footnote.new(index, node.target, footnote_text)
           doc.register(:footnotes, footnote)
-- 
2.32.0.rc0


  parent reply	other threads:[~2021-05-21 22:45 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-21 22:44 [PATCH v2 00/11] doc: asciidoctor: direct man page creation and fixes Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 01/11] doc: doc-diff: set docdate manually Felipe Contreras
2021-05-22  4:25   ` Bagas Sanjaya
2021-05-22 21:27     ` Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 02/11] doc-diff: drop --cut-footer switch Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 03/11] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-06-02 20:11   ` Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 04/11] doc-diff: support asciidoctor man pages Felipe Contreras
2021-05-21 22:52   ` Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 05/11] doc: asciidoctor: add linkgit macros in " Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 06/11] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 07/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 08/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-21 22:44 ` Felipe Contreras [this message]
2021-05-21 22:44 ` [PATCH v2 10/11] doc: asciidoctor: cleanup man page hack Felipe Contreras
2021-05-21 22:44 ` [PATCH v2 11/11] doc: asciidoctor: add hack for old versions Felipe Contreras
2021-05-21 22:51 ` [PATCH v2 00/11] doc: asciidoctor: direct man page creation and fixes 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=20210521224452.530852-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).