git.vger.kernel.org archive mirror
 help / color / mirror / 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 10/11] doc: asciidoctor: add support for baseurl
Date: Fri, 14 May 2021 07:14:34 -0500	[thread overview]
Message-ID: <20210514121435.504423-11-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210514121435.504423-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 a514a4e72c..cc5ff54d92 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -193,6 +193,7 @@ ASCIIDOC_DOCBOOK = docbook5
 override ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
 override ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
 override ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
+override 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 42133ee6c3..2ed92c3055 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -17,7 +17,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.31.1


  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 ` [PATCH 08/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-14 12:14 ` [PATCH 09/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-14 12:14 ` Felipe Contreras [this message]
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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210514121435.504423-11-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.
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 NNTP newsgroup(s).