]> git.proxmox.com Git - pve-docs.git/commit - asciidoc-pve.in
asciidoc-pve: ignore link targets for non-manpages
authorThomas Lamprecht <t.lamprecht@proxmox.com>
Tue, 12 Feb 2019 09:44:49 +0000 (10:44 +0100)
committerWolfgang Bumiller <w.bumiller@proxmox.com>
Wed, 13 Feb 2019 08:57:30 +0000 (09:57 +0100)
commit7de8bba68de1875aca04ebd1cd941a2992c24753
treef3451f4bfc0a90b75b7313b942f9db951011376e
parentcb41b5d9e50f748c51d8da93a37d88dca0f7bd9b
asciidoc-pve: ignore link targets for non-manpages

To allow linking from to a chapter/section not included in a manpage
allow the manpage link resolver to just return text in a case the
link target text is in fact no manpage.

If the link is a valid one in general will be checked in a lot of
other places, so here we won't run into a regression where a wrong,
non-existing, link does not get detected by the build system.

The particular case I run into problems with this is when linking
from the pveceph chapter to the pve-package-repos, to point to the
(cheph) repos. pve-package-repos is no where included or itself a
manpage, so this checks fails. Even if we say it would make sense to
have it as a manpage, which was my initial solution, we run then into
issues as we have a link to a outside reference, located in
pve-bibliography, which then we probably do not want as manpage.

So in the case where a valid link, which just has no manpage counter
part, is passed to the respective link resolver I just return the
link text as is. An alternative could be to get the link object and
put it in parentheses after the link text, but I'm not to sure about
this so let's for now go the easier route.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
asciidoc-pve.in