[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Xen-changelog] [xen staging] docs: Fix all links to Xen man pages in html



commit 08b908ba63dee8bc313983c5e412852cbcbcda85
Author:     Anthony PERARD <anthony.perard@xxxxxxxxxx>
AuthorDate: Wed Jan 16 16:16:56 2019 +0000
Commit:     Wei Liu <wei.liu2@xxxxxxxxxx>
CommitDate: Tue Jan 22 11:42:23 2019 +0000

    docs: Fix all links to Xen man pages in html
    
    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@xxxxxxxxxx>
    Acked-by: Ian Jackson <ian.jackson@xxxxxxxxxxxxx>
    Release-acked-by: Juergen Gross <jgross@xxxxxxxx>
---
 docs/Makefile | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/docs/Makefile b/docs/Makefile
index cbc61e3f1d..44aebf079d 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -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
--
generated by git-patchbot for /home/xen/git/xen.git#staging

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog

 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.