Re: [Xen-devel] [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

[Anthony PERARD <anthony.perard@xxxxxxxxxx>]

> > On 2 Aug 2018, at 12:24, Lars Kurth <lars.kurth@xxxxxxxxxx> wrote:
> > 
> > Hi all,
> > 
> > most of our man pages on pretty much all releases from 4.2 contain broken 
> > links. 
> > 
> > For example:
> > In https://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html the source 
> > contains:
> > 
> > "For more details, see L<xl-numa-placement(7)>." 
> > Maps onto http://man.he.net/man7/xl-numa-placement  (does not exist)
> > 
> > “See L<http://man.he.net/man5/xl-disk-configuration> for more details.” 
> > Maps onto http://man.he.net/man5/xl-disk-configuration (does not exist)
> > 
> > Etc.
> > 
> > There seem to be two issues:
> > * The root path http://man.he.net, which is incorrect
> > * The resolution of filenames to man<x>/<name>: should be 
> > man/<name>.<x>.html
> > 
> > Probably we need to feed some arguments to probably we need to feed some 
> > arguments 
> > to pod2html in order to generate the correct urls. See  
> > https://perldoc.perl.org/pod2html.html 
> > (maybe we need we need –htmldir). For our docs build, this should probably 
> > go to 
> > https://xenbits.xen.org/docs/unstable/man/ while for local installs to 
> > ${prefix}/share/doc/xen/html/man or something like it.
> > 
> > I had a look to see whether I can fix this, but that seems a little too 
> > complex for me

I've managed to do something about it, and it is indeed complex. But
maybe pod2html isn't the right tool. Anyway, I have got two patchs to
follow.

-- 
Anthony PERARD

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