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

[Wei Liu <wei.liu2@xxxxxxxxxx>]

On Thu, Dec 08, 2016 at 05:56:12PM +0100, 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>
> ---
>  docs/man/xl.cfg.pod.5.in | 16 ++++++++--------
>  docs/man/xl.pod.1.in     |  2 +-
>  m4/paths.m4              |  3 +++
>  3 files changed, 12 insertions(+), 9 deletions(-)
> 
> diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
> index 21b58bc21e..29a012b794 100644
> --- a/docs/man/xl.cfg.pod.5.in
> +++ b/docs/man/xl.cfg.pod.5.in
> @@ -185,7 +185,7 @@ host cpus and memory. In that case, the soft affinity of 
> all the vcpus
>  of the domain will be set to the pcpus belonging to the NUMA nodes
>  chosen during placement.
>  
> -For more details, see F<docs/misc/xl-numa-placement.markdown>.
> +For more details, see L</@XEN_DOC_DIR@/docs/misc/xl-numa-placement.markdown>.

I think this is a sensible thing to do. But should you omit the leading
"/" in all instances?

Wei.

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