]> xenbits.xensource.com Git - people/dwmw2/xen.git/commitdiff
docs: Fix all links to Xen man pages in html
authorAnthony PERARD <anthony.perard@citrix.com>
Wed, 16 Jan 2019 16:16:56 +0000 (16:16 +0000)
committerWei Liu <wei.liu2@citrix.com>
Tue, 22 Jan 2019 11:42:23 +0000 (11:42 +0000)
Second try, this time also works for all links to xen-vbd-interface(7).

We don't try anymore to have pod2html generate relative links, instead
we do it ourself.

First, we modify all links to man pages to have what looks like an
absolute URL and pod2html will just write it in the html output.
Absolute URL in POD are in the form L<text|scheme:...> so let's just use
a scheme that isn't real, but easy to find in the resulting html output:
"relative:".

Then we fix the output and remove all the bogus scheme "relative" and
can end up with nice relative links.

Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
Release-acked-by: Juergen Gross <jgross@suse.com>
docs/Makefile

index cbc61e3f1d25c88adc44ebf43e09fc42e720fd71..44aebf079d38b3749d98264cc661bf44bfe23a37 100644 (file)
@@ -96,8 +96,12 @@ endif
 html/man/%.$(1).html: man/%.$(1).pod Makefile
 ifneq ($(POD2HTML),)
        @$(INSTALL_DIR) $$(@D)
-       sed -r -e 's%L<([^>]+)\(([1-9])\)>%L<\1(\2)|\1.\2>%g' $$< | \
-               (cd man; $(POD2HTML) --podpath=. --htmlroot=. --outfile=../$$@)
+       # Fix up links between man-pages
+       # 1) L<xl(1)> -> L<xl(1)|relative:xl.1.html>
+       # 2) <a href="relative:xl.1.html"> -> <a href="xl.1.html">
+       sed -r -e 's%L<([^>]+)\(([1-9])\)>%L<\1(\2)|relative:\1.\2.html>%g' $$< | \
+               $(POD2HTML) | \
+               sed -r -e 's%( href=")relative:%\1%g' > $$@
 else
        @echo "pod2html not installed; skipping $$@"
 endif