* [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* [PATCH v2 2/2] man: Highlight reference in xl-disk-configuration(5)
2019-01-16 16:16 [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
@ 2019-01-16 16:16 ` Anthony PERARD
2019-01-22 11:39 ` Juergen Gross
2019-01-22 10:27 ` [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-22 11:38 ` Juergen Gross
2 siblings, 1 reply; 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, Ian Jackson
Provide a better way to see the link to a different manpage, with simple
words.
Suggested-by: Ian Jackson <ian.jackson@citrix.com>
Signed-off-by: Anthony PERARD <anthony.perard@citrix.com>
Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
docs/man/xl-disk-configuration.5.pod | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/man/xl-disk-configuration.5.pod b/docs/man/xl-disk-configuration.5.pod
index d3eedc1926..eea893ef91 100644
--- a/docs/man/xl-disk-configuration.5.pod
+++ b/docs/man/xl-disk-configuration.5.pod
@@ -123,7 +123,7 @@ raw
=item Description
Virtual device as seen by the guest (also referred to as guest drive
-designation in some specifications). L<xen-vbd-interface(7)>
+designation in some specifications). See L<xen-vbd-interface(7)>.
=item Supported values
--
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
* Re: [PATCH v2 1/2] docs: Fix all links to Xen man pages in html
2019-01-16 16:16 [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-16 16:16 ` [PATCH v2 2/2] man: Highlight reference in xl-disk-configuration(5) Anthony PERARD
@ 2019-01-22 10:27 ` Anthony PERARD
2019-01-22 11:38 ` Juergen Gross
2 siblings, 0 replies; 6+ messages in thread
From: Anthony PERARD @ 2019-01-22 10:27 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Andrew Cooper, Ian Jackson, Wei Liu
On Wed, Jan 16, 2019 at 04:16:56PM +0000, Anthony PERARD wrote:
> 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>
Juergen, could you release-ack this patch and the following one[1]?
Thanks,
[1] xen: Highlight reference in xl-disk-configuration(5)
--
Anthony PERARD
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] docs: Fix all links to Xen man pages in html
2019-01-16 16:16 [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-16 16:16 ` [PATCH v2 2/2] man: Highlight reference in xl-disk-configuration(5) Anthony PERARD
2019-01-22 10:27 ` [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
@ 2019-01-22 11:38 ` Juergen Gross
2019-01-22 11:42 ` Wei Liu
2 siblings, 1 reply; 6+ messages in thread
From: Juergen Gross @ 2019-01-22 11:38 UTC (permalink / raw)
To: Anthony PERARD, xen-devel; +Cc: Andrew Cooper, Ian Jackson, Wei Liu
On 16/01/2019 17:16, Anthony PERARD wrote:
> 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>
Juergen
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v2 1/2] docs: Fix all links to Xen man pages in html
2019-01-22 11:38 ` Juergen Gross
@ 2019-01-22 11:42 ` Wei Liu
0 siblings, 0 replies; 6+ messages in thread
From: Wei Liu @ 2019-01-22 11:42 UTC (permalink / raw)
To: Juergen Gross
Cc: Anthony PERARD, xen-devel, Ian Jackson, Wei Liu, Andrew Cooper
On Tue, Jan 22, 2019 at 12:38:36PM +0100, Juergen Gross wrote:
> On 16/01/2019 17:16, Anthony PERARD wrote:
> > 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>
Now pushed. Thanks.
Wei.
_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-01-22 11:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-01-16 16:16 [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-16 16:16 ` [PATCH v2 2/2] man: Highlight reference in xl-disk-configuration(5) Anthony PERARD
2019-01-22 11:39 ` Juergen Gross
2019-01-22 10:27 ` [PATCH v2 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-22 11:38 ` Juergen Gross
2019-01-22 11:42 ` Wei Liu
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.