All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Anthony PERARD <anthony.perard@citrix.com>,
	xen-devel@lists.xenproject.org
Cc: Ian Jackson <ian.jackson@eu.citrix.com>, Wei Liu <wei.liu2@citrix.com>
Subject: Re: [PATCH 1/2] docs: Fix all links to Xen man pages in html
Date: Tue, 15 Jan 2019 18:30:13 +0000	[thread overview]
Message-ID: <a5b66bc4-f72d-2a5c-e468-a8303082457b@citrix.com> (raw)
In-Reply-To: <20190115182159.17494-1-anthony.perard@citrix.com>

On 15/01/2019 18:21, Anthony PERARD wrote:
> diff --git a/docs/Makefile b/docs/Makefile
> index cbc61e3f1d..974d9089ed 100644
> --- a/docs/Makefile
> +++ b/docs/Makefile
> @@ -96,8 +96,9 @@ endif
>  html/man/%.$(1).html: man/%.$(1).pod Makefile
>  ifneq ($(POD2HTML),)
>  	@$(INSTALL_DIR) $$(@D)

I've got no specific comment on the sedary, but please can we we have a
comment here explaining what is going on so some poor sole in 6 months
time stands a chance of figuring this out.

    # Fix up man-page links to work with the resulting html/ layout.

or equivalent.

~Andrew

> -	sed -r -e 's%L<([^>]+)\(([1-9])\)>%L<\1(\2)|\1.\2>%g' $$< | \
> -		(cd man; $(POD2HTML) --podpath=. --htmlroot=. --outfile=../$$@)
> +	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


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

  reply	other threads:[~2019-01-15 18:59 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-02 11:24 [BUG] docs: our man page generation uses http://man.he.net/ by default which causes broken links. It should be changed to point to a relative path Lars Kurth
2018-08-02 11:25 ` Lars Kurth
2019-01-11 14:15 ` Lars Kurth
2019-01-15 15:47   ` Anthony PERARD
2019-01-15 15:48     ` [PATCH 1/2] man: Fix links in xl(1) Anthony PERARD
2019-01-15 15:54       ` Ian Jackson
2019-01-15 17:13         ` Juergen Gross
2019-01-15 15:48     ` [PATCH 2/2] docs: Fix links in html generation of man pages Anthony PERARD
2019-01-15 15:57       ` Ian Jackson
2019-01-15 16:17         ` Anthony PERARD
2019-01-15 17:07           ` Ian Jackson
2019-01-15 17:14             ` Juergen Gross
2019-01-15 17:33             ` Anthony PERARD
2019-01-15 17:44               ` Ian Jackson
2019-01-15 18:21               ` [PATCH 1/2] docs: Fix all links to Xen man pages in html Anthony PERARD
2019-01-15 18:30                 ` Andrew Cooper [this message]
2019-01-15 19:16                   ` Ian Jackson
2019-01-16 16:07                     ` Anthony PERARD
2019-01-15 19:15                 ` Ian Jackson
2019-01-15 18:21               ` [PATCH 2/2] man: Highlight reference in xl-disk-configuration(5) Anthony PERARD
2019-01-15 19:14                 ` Ian Jackson
2019-01-15 17:41             ` [PATCH 2/2] docs: Fix links in html generation of man pages Lars Kurth

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a5b66bc4-f72d-2a5c-e468-a8303082457b@citrix.com \
    --to=andrew.cooper3@citrix.com \
    --cc=anthony.perard@citrix.com \
    --cc=ian.jackson@eu.citrix.com \
    --cc=wei.liu2@citrix.com \
    --cc=xen-devel@lists.xenproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.