Re: [PATCH 3/3] docs: add more info about target= in disk config

[Ian Campbell <ian.campbell@citrix.com>]

On Tue, 2016-02-16 at 20:54 -0700, Jim Fehlig wrote:
> target= in disk config can be used to convey arbitrary
> configuration information to backends. Add a bit more info
> to xl-disk-configuration.txt to clarify this, including some
> simple nbd and rbd qdisk configurations.

Missing S-o-b.

> ---
>  docs/misc/xl-disk-configuration.txt | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/misc/xl-disk-configuration.txt b/docs/misc/xl-disk-
> configuration.txt
> index 29f6ddb..0918fb8 100644
> --- a/docs/misc/xl-disk-configuration.txt
> +++ b/docs/misc/xl-disk-configuration.txt
> @@ -75,7 +75,15 @@ Special syntax:
>     the target was already specified as a positional parameter.  This
>     is the only way to specify a target string containing metacharacters
>     such as commas and (in some cases) colons, which would otherwise be
> -   misinterpreted.
> +   misinterpreted. Meta-information in a target string can be used to
> +   specify configuration information for a qdisk block backend. For
> +   example the nbd and rbd qdisk block backends can be configured with
> +
> +     target=nbd:192.168.0.1:5555
> +     target=rbd:pool/image:mon_host=192.186.0.1\\:6789
> +
> +   Note the use of double backslash ('\\') for metacharacters that need
> +   escaped.

"need to be escaped".

However I wouldn't describe "\\" that way, I think I would say "note that \
is used to escape metacharacters and therefore to get a literal backslash
"\\" is required".

The general concept of escaping metacharaters is not mentioned in this doc
at all, i.e. there is no mention of which characters need such escaping nor
of the various "special" codes (\t and \n etc), nor of the octal and hex
escape codes. Maybe that's a topic for another patch though.

Ian.


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