mirror of
https://github.com/git/git.git
synced 2024-10-30 22:07:53 +01:00
60475183c0
Commit fe77b41 introduced a new attribute to let the linkgit macro
create cross-directory HTML references from the technical/ and howto/
subdirectories back to the main documentation. We define that attribute
to "../" on the command-line when building inside those subdirectories,
and otherwise leave it unset under the assumption that it would default
to being blank. Instead, asciidoc omits the link entirely, leading to
broken documentation. Fix this by defining git-relative-html-prefix to
blank in asciidoc.conf (and an instance on the command-line, when
present, will override it).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
97 lines
2.3 KiB
Text
97 lines
2.3 KiB
Text
## linkgit: macro
|
|
#
|
|
# Usage: linkgit:command[manpage-section]
|
|
#
|
|
# Note, {0} is the manpage section, while {target} is the command.
|
|
#
|
|
# Show GIT link as: <command>(<section>); if section is defined, else just show
|
|
# the command.
|
|
|
|
[macros]
|
|
(?su)[\\]?(?P<name>linkgit):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
|
|
|
|
[attributes]
|
|
asterisk=*
|
|
plus=+
|
|
caret=^
|
|
startsb=[
|
|
endsb=]
|
|
backslash=\
|
|
tilde=~
|
|
apostrophe='
|
|
backtick=`
|
|
litdd=--
|
|
|
|
ifdef::backend-docbook[]
|
|
[linkgit-inlinemacro]
|
|
{0%{target}}
|
|
{0#<citerefentry>}
|
|
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
|
|
{0#</citerefentry>}
|
|
endif::backend-docbook[]
|
|
|
|
ifdef::backend-docbook[]
|
|
ifndef::git-asciidoc-no-roff[]
|
|
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
|
|
# v1.72 breaks with this because it replaces dots not in roff requests.
|
|
[listingblock]
|
|
<example><title>{title}</title>
|
|
<literallayout>
|
|
ifdef::doctype-manpage[]
|
|
.ft C
|
|
endif::doctype-manpage[]
|
|
|
|
|
ifdef::doctype-manpage[]
|
|
.ft
|
|
endif::doctype-manpage[]
|
|
</literallayout>
|
|
{title#}</example>
|
|
endif::git-asciidoc-no-roff[]
|
|
|
|
ifdef::git-asciidoc-no-roff[]
|
|
ifdef::doctype-manpage[]
|
|
# The following two small workarounds insert a simple paragraph after screen
|
|
[listingblock]
|
|
<example><title>{title}</title>
|
|
<literallayout>
|
|
|
|
|
</literallayout><simpara></simpara>
|
|
{title#}</example>
|
|
|
|
[verseblock]
|
|
<formalpara{id? id="{id}"}><title>{title}</title><para>
|
|
{title%}<literallayout{id? id="{id}"}>
|
|
{title#}<literallayout>
|
|
|
|
|
</literallayout>
|
|
{title#}</para></formalpara>
|
|
{title%}<simpara></simpara>
|
|
endif::doctype-manpage[]
|
|
endif::git-asciidoc-no-roff[]
|
|
endif::backend-docbook[]
|
|
|
|
ifdef::doctype-manpage[]
|
|
ifdef::backend-docbook[]
|
|
[header]
|
|
template::[header-declarations]
|
|
<refentry>
|
|
<refmeta>
|
|
<refentrytitle>{mantitle}</refentrytitle>
|
|
<manvolnum>{manvolnum}</manvolnum>
|
|
<refmiscinfo class="source">Git</refmiscinfo>
|
|
<refmiscinfo class="version">{git_version}</refmiscinfo>
|
|
<refmiscinfo class="manual">Git Manual</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>{manname}</refname>
|
|
<refpurpose>{manpurpose}</refpurpose>
|
|
</refnamediv>
|
|
endif::backend-docbook[]
|
|
endif::doctype-manpage[]
|
|
|
|
ifdef::backend-xhtml11[]
|
|
[attributes]
|
|
git-relative-html-prefix=
|
|
[linkgit-inlinemacro]
|
|
<a href="{git-relative-html-prefix}{target}.html">{target}{0?({0})}</a>
|
|
endif::backend-xhtml11[]
|