All of lore.kernel.org
 help / color / mirror / Atom feed
From: Anthony PERARD <anthony.perard@citrix.com>
To: Ian Jackson <ian.jackson@citrix.com>
Cc: "xen-devel@lists.xenproject.org" <xen-devel@lists.xenproject.org>,
	Wei Liu <wei.liu2@citrix.com>, Lars Kurth <lars.kurth@citrix.com>
Subject: Re: [PATCH 2/2] docs: Fix links in html generation of man pages
Date: Tue, 15 Jan 2019 16:17:15 +0000	[thread overview]
Message-ID: <20190115161715.GG1271@perard.uk.xensource.com> (raw)
In-Reply-To: <23614.751.197837.290432@mariner.uk.xensource.com>

On Tue, Jan 15, 2019 at 03:57:35PM +0000, Ian Jackson wrote:
> Anthony PERARD writes ("[PATCH 2/2] docs: Fix links in html generation of man pages"):
> > Currently, all links to other man pages are sent to
> > http://man.he.net/man$mansection/$manpage, but that site doesn't have
> > Xen man pages, so all links to other Xen man pages are broken.
> > 
> > In order to fix that, this is going to be a bit complex.
> 
> Cor.  Thanks for digging.  Your approach seems no worse than is to be
> expected under the circumstances.  (So, well done.)
> 
> Do you have an example of the resulting output ?  You could put it on
> xenbits and then it would be easy to diff it.

Maybe: https://xenbits.xenproject.org/people/aperard/2019/man/

But here is a sample (the only not working link will be in
xl-disk-configuration, all other links works like shown in the diff of
xl.cfg):

--- html/man/xl-disk-configuration.5.html	2019-01-15 16:04:18.913012326 +0000
+++ html-man-v1/xl-disk-configuration.5.html	2019-01-15 16:01:35.922122233 +0000
@@ -150,7 +150,7 @@
 <dt id="Description2">Description</dt>
 <dd>
 
-<p>Virtual device as seen by the guest (also referred to as guest drive designation in some specifications). <a href="http://man.he.net/man7/xen-vbd-interface">xen-vbd-interface(7)</a></p>
+<p>Virtual device as seen by the guest (also referred to as guest drive designation in some specifications). <a>xen-vbd-interface(7)</a></p>
 
 </dd>
 <dt id="Supported-values2">Supported values</dt>

--- html/man/xl.cfg.5.html	2019-01-15 16:04:19.146342181 +0000
+++ html-man-v1/xl.cfg.5.html	2019-01-15 16:01:36.222117709 +0000
@@ -274,7 +274,7 @@
 
 <p>If this option is not specified (and <b>cpus=</b> is not specified either), libxl automatically tries to place the guest on the least possible number of nodes. A heuristic approach is used for choosing the best node (or set of nodes), with the goal of maximizing performance for the guest and, at the same time, achieving efficient utilization of host CPUs and memory. In that case, the soft affinity of all the vCPUs of the domain will be set to host CPUs belonging to NUMA nodes chosen during placement.</p>
 
-<p>For more details, see <a href="http://man.he.net/man7/xl-numa-placement">xl-numa-placement(7)</a>.</p>
+<p>For more details, see <a href="./xl-numa-placement.7.html">xl-numa-placement(7)</a>.</p>
 
 </dd>
 </dl>
@@ -2651,27 +2651,27 @@
 
 <dl>
 
-<dt id="xl-1"><a href="http://man.he.net/man1/xl">xl(1)</a></dt>
+<dt id="xl-1"><a href="./xl.1.html">xl(1)</a></dt>
 <dd>
 
 </dd>
-<dt id="xl.conf-5"><a href="http://man.he.net/man5/xl.conf">xl.conf(5)</a></dt>
+<dt id="xl.conf-5"><a href="./xl.conf.5.html">xl.conf(5)</a></dt>
 <dd>
 
 </dd>
-<dt id="xlcpupool.cfg-5"><a href="http://man.he.net/man5/xlcpupool.cfg">xlcpupool.cfg(5)</a></dt>
+<dt id="xlcpupool.cfg-5"><a href="./xlcpupool.cfg.5.html">xlcpupool.cfg(5)</a></dt>
 <dd>
 
 </dd>
-<dt id="xl-disk-configuration-5"><a href="http://man.he.net/man5/xl-disk-configuration">xl-disk-configuration(5)</a></dt>
+<dt id="xl-disk-configuration-5"><a href="./xl-disk-configuration.5.html">xl-disk-configuration(5)</a></dt>
 <dd>
 
 </dd>
-<dt id="xl-network-configuration-5"><a href="http://man.he.net/man5/xl-network-configuration">xl-network-configuration(5)</a></dt>
+<dt id="xl-network-configuration-5"><a href="./xl-network-configuration.5.html">xl-network-configuration(5)</a></dt>
 <dd>
 
 </dd>
-<dt id="xen-tscmode-7"><a href="http://man.he.net/man7/xen-tscmode">xen-tscmode(7)</a></dt>
+<dt id="xen-tscmode-7"><a href="./xen-tscmode.7.html">xen-tscmode(7)</a></dt>
 <dd>
 
 </dd>


-- 
Anthony PERARD

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

  reply	other threads:[~2019-01-15 16:18 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 [this message]
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
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=20190115161715.GG1271@perard.uk.xensource.com \
    --to=anthony.perard@citrix.com \
    --cc=ian.jackson@citrix.com \
    --cc=lars.kurth@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.