[PATCH v2 1/2] docs: Fix all links to Xen man pages in html

* [PATCH v2 1/2] docs: Fix all links to Xen man pages in html
@ 2019-01-16 16:16 Anthony PERARD
  2019-01-16 16:16 ` [PATCH v2 2/2] man: Highlight reference in xl-disk-configuration(5) Anthony PERARD
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Anthony PERARD @ 2019-01-16 16:16 UTC (permalink / raw)
  To: xen-devel
  Cc: Juergen Gross, Anthony PERARD, Ian Jackson, Wei Liu, Andrew Cooper

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>
---
v2:
    adding a comment

CC: Andrew Cooper <andrew.cooper3@citrix.com>
---
 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
-- 
Anthony PERARD


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

^ permalink raw reply related	[flat|nested] 6+ messages in thread