From: Wei Liu <wei.liu2@citrix.com>
To: "Cédric Bosdonnat" <cbosdonnat@suse.com>
Cc: Ian Jackson <ian.jackson@eu.citrix.com>,
Wei Liu <wei.liu2@citrix.com>,
xen-devel@lists.xen.org
Subject: Re: [PATCH] docs: turn links to docs/* into absolute path
Date: Thu, 8 Dec 2016 17:59:48 +0000 [thread overview]
Message-ID: <20161208175948.GG2940@citrix.com> (raw)
In-Reply-To: <20161208165612.14223-1-cbosdonnat@suse.com>
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@suse.com>
> ---
> 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@lists.xen.org
https://lists.xen.org/xen-devel
next prev parent reply other threads:[~2016-12-08 17:59 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-08 16:56 [PATCH] docs: turn links to docs/* into absolute path Cédric Bosdonnat
2016-12-08 17:59 ` Andrew Cooper
2016-12-09 8:10 ` Cedric Bosdonnat
2016-12-09 11:25 ` Ian Jackson
2016-12-09 12:02 ` Cedric Bosdonnat
2016-12-09 16:51 ` Wei Liu
2016-12-08 17:59 ` Wei Liu [this message]
2016-12-09 8:08 ` Cedric Bosdonnat
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=20161208175948.GG2940@citrix.com \
--to=wei.liu2@citrix.com \
--cc=cbosdonnat@suse.com \
--cc=ian.jackson@eu.citrix.com \
--cc=xen-devel@lists.xen.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).