From mboxrd@z Thu Jan  1 00:00:00 1970
From: Wei Liu <wei.liu2@citrix.com>
Subject: Re: [PATCH] docs: document handling of metacharacter
 escape	in xl disk format
Date: Wed, 24 Feb 2016 11:56:06 +0000
Message-ID: <20160224115606.GM3723@citrix.com>
References: <1455793357-5712-1-git-send-email-ian.campbell@citrix.com>
	<56C64955.7000909@suse.com> <1455876850.6225.73.camel@citrix.com>
	<1455877406.6225.77.camel@citrix.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Return-path: <xen-devel-bounces@lists.xen.org>
Content-Disposition: inline
In-Reply-To: <1455877406.6225.77.camel@citrix.com>
List-Unsubscribe: <http://lists.xen.org/cgi-bin/mailman/options/xen-devel>,
	<mailto:xen-devel-request@lists.xen.org?subject=unsubscribe>
List-Post: <mailto:xen-devel@lists.xen.org>
List-Help: <mailto:xen-devel-request@lists.xen.org?subject=help>
List-Subscribe: <http://lists.xen.org/cgi-bin/mailman/listinfo/xen-devel>,
	<mailto:xen-devel-request@lists.xen.org?subject=subscribe>
Sender: xen-devel-bounces@lists.xen.org
Errors-To: xen-devel-bounces@lists.xen.org
To: Ian Campbell <ian.campbell@citrix.com>
Cc: ian.jackson@eu.citrix.com, Jim Fehlig <jfehlig@suse.com>, wei.liu2@citrix.com, xen-devel@lists.xen.org
List-Id: xen-devel@lists.xenproject.org

On Fri, Feb 19, 2016 at 10:23:26AM +0000, Ian Campbell wrote:
> On Fri, 2016-02-19 at 10:14 +0000, Ian Campbell wrote:
> > On Thu, 2016-02-18 at 15:44 -0700, Jim Fehlig wrote:
> > > Ian Campbell wrote:
> > > > Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
> > > > Cc: Jim Fehlig <jfehlig@suse.com>
> > > > ---
> > > > =A0docs/misc/xl-disk-configuration.txt | 18 ++++++++++++++++++
> > > > =A01 file changed, 18 insertions(+)
> > > > =

> > > > diff --git a/docs/misc/xl-disk-configuration.txt b/docs/misc/xl-dis=
k-
> > > > configuration.txt
> > > > index 6a2118d..a03ad10 100644
> > > > --- a/docs/misc/xl-disk-configuration.txt
> > > > +++ b/docs/misc/xl-disk-configuration.txt
> > > > @@ -48,6 +48,24 @@ positionally or explicitly).
> > > > =A0
> > > > =A0Whitespace may appear before each parameter and will be ignored.
> > > > =A0
> > > > +Metacharacters in a <diskspec> may be escaped using a backslash:
> > > > +
> > > > +=A0=A0=A0=A0Escape=A0=A0=A0=A0=A0=A0HEX=A0=A0=A0=A0=A0Description
> > > > +=A0=A0=A0=A0------=A0=A0=A0=A0=A0=A0---=A0=A0=A0=A0=A0-----------
> > > > +=A0=A0=A0=A0\a=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x07=A0=A0=A0=A0Bell
> > > > +=A0=A0=A0=A0\b=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x08=A0=A0=A0=A0Backsp=
ace
> > > > +=A0=A0=A0=A0\t=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x09=A0=A0=A0=A0Horizo=
ntal Tab
> > > > +=A0=A0=A0=A0\n=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x0A=A0=A0=A0=A0New Li=
ne / Line Feed
> > > > +=A0=A0=A0=A0\f=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x0C=A0=A0=A0=A0Form F=
eed
> > > > +=A0=A0=A0=A0\r=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x0D=A0=A0=A0=A0Carria=
ge Return
> > > > +=A0=A0=A0=A0\v=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x0B=A0=A0=A0=A0Vertic=
al Tab
> > > > +=A0=A0=A0=A0\"=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x22=A0=A0=A0=A0A lite=
ral double quote
> > > > +=A0=A0=A0=A0\'=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x27=A0=A0=A0=A0A lite=
ral single quote
> > > > +=A0=A0=A0=A0\\=A0=A0=A0=A0=A0=A0=A0=A0=A0=A00x5C=A0=A0=A0=A0A lite=
ral backslash
> > > > +=A0=A0=A0=A0\xXX=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0Ch=
aracter XX in hexadecimal
> > > > +=A0=A0=A0=A0\OOO=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0=A0Ch=
aracter OOO in octal
> > > =

> > > Do you know how any of these would be useful in a diskspec? I guess I=
'm
> > > struggling to understand when a 'Bell' would be needed :-).
> > =

> > I've not got a clue -- these are just all the ones handled by
> > xlu__cfgl_dequote, perhaps just for completeness?
> > =

> > This is applied to all strings in a cfg file, not just diskspecs,
> =

> Having observed this it should have then occurred to me that perhaps this
> needs to be documented in xl.cfg(5) instead of in a disk specific locatio=
n.
> =

> Should I move the above to=A0docs/man/xl.cfg.pod.5 and apply pod markup to
> it?

Agreed.