Re: [Xen-devel] [PATCH] docs: turn links to docs/* into absolute path

[Andrew Cooper <andrew.cooper3@xxxxxxxxxx>]

On 08/12/16 16:56, Cédric Bosdonnat wrote:
> From a user point of view, when reading things like "See
> docs/misc/....txt" in a man page, it is not obvious to find the
> location of that file. Use $docdir to turn these into absolute
> paths.
>
> Signed-off-by: Cédric Bosdonnat <cbosdonnat@xxxxxxxx>

Hmm.  I can see your point and we really should improve the man pages.

However, this change will cause
http://xenbits.xen.org/docs/unstable/man/xl.cfg.5.html to point at a
local file rather than something which is reasonably accessable from the
webroot.

Another issue to consider is that some packagers only package the
manpages, not the other misc text content.  (I would argue that none of
the manpages should refer to misc text content in the first place).

The web docs are already in a fairly poor state in this regards, so I
don't know whether it might just be better to taking this patch.

~Andrew

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel