summaryrefslogtreecommitdiff
path: root/Documentation/asciidoctor-extensions.rb
diff options
context:
space:
mode:
authorLibravatar Martin Ågren <martin.agren@gmail.com>2019-02-27 19:17:54 +0100
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-03-11 18:22:07 +0900
commit185f9a0ea05a00aadbfce56bce21fe2909ae139c (patch)
tree3d74ca1bcbb5185b76e382c726aca8dd0b54c8e1 /Documentation/asciidoctor-extensions.rb
parentDocumentation/Makefile: add missing dependency on asciidoctor-extensions (diff)
downloadtgif-185f9a0ea05a00aadbfce56bce21fe2909ae139c.tar.xz
asciidoctor-extensions: fix spurious space after linkgit
When we render, e.g., "linkgit:gitglossary[7]." with Asciidoctor, we get "gitglossary(7) ." with a space between the linkgit macro expansion and the punctuation. We can fix this by dropping the trailing newline after we've turned `linkgit:foo[bar]` into `<citerefentry>..</citerefentry>`. The diff produced by `USE_ASCIIDOCTOR=Yes ./doc-diff HEAD^ HEAD` is almost 6000 lines large and shows how this fixes "git-foo(x) ,", "(see git-bar(y) )" and so on. One might wonder whether this also turns, e.g., "see linkgit:foo[1] for more" into "see foo(1)for more", but no. We get "...</citerefentry> for more" in the XML, see, e.g., git-am.xml, so the space ends up in git-am.1 just fine. The same is true for the HTML output. Signed-off-by: Martin Ågren <martin.agren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/asciidoctor-extensions.rb')
-rw-r--r--Documentation/asciidoctor-extensions.rb4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/asciidoctor-extensions.rb b/Documentation/asciidoctor-extensions.rb
index ec83b4959e..0089e0cfb8 100644
--- a/Documentation/asciidoctor-extensions.rb
+++ b/Documentation/asciidoctor-extensions.rb
@@ -11,12 +11,12 @@ module Git
def process(parent, target, attrs)
if parent.document.basebackend? 'html'
prefix = parent.document.attr('git-relative-html-prefix')
- %(<a href="#{prefix}#{target}.html">#{target}(#{attrs[1]})</a>\n)
+ %(<a href="#{prefix}#{target}.html">#{target}(#{attrs[1]})</a>)
elsif parent.document.basebackend? 'docbook'
"<citerefentry>\n" \
"<refentrytitle>#{target}</refentrytitle>" \
"<manvolnum>#{attrs[1]}</manvolnum>\n" \
- "</citerefentry>\n"
+ "</citerefentry>"
end
end
end