Re: [Xen-devel] [PATCH] docs: document handling of metacharacter escape in xl disk format

[Ian Campbell <ian.campbell@xxxxxxxxxx>]

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@xxxxxxxxxx>
> > > Cc: Jim Fehlig <jfehlig@xxxxxxxx>
> > > ---
> > > Âdocs/misc/xl-disk-configuration.txt | 18 ++++++++++++++++++
> > > Â1 file changed, 18 insertions(+)
> > > 
> > > diff --git a/docs/misc/xl-disk-configuration.txt b/docs/misc/xl-disk-
> > > 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).
> > > Â
> > > ÂWhitespace may appear before each parameter and will be ignored.
> > > Â
> > > +Metacharacters in a <diskspec> may be escaped using a backslash:
> > > +
> > > +ÂÂÂÂEscapeÂÂÂÂÂÂHEXÂÂÂÂÂDescription
> > > +ÂÂÂÂ------ÂÂÂÂÂÂ---ÂÂÂÂÂ-----------
> > > +ÂÂÂÂ\aÂÂÂÂÂÂÂÂÂÂ0x07ÂÂÂÂBell
> > > +ÂÂÂÂ\bÂÂÂÂÂÂÂÂÂÂ0x08ÂÂÂÂBackspace
> > > +ÂÂÂÂ\tÂÂÂÂÂÂÂÂÂÂ0x09ÂÂÂÂHorizontal Tab
> > > +ÂÂÂÂ\nÂÂÂÂÂÂÂÂÂÂ0x0AÂÂÂÂNew Line / Line Feed
> > > +ÂÂÂÂ\fÂÂÂÂÂÂÂÂÂÂ0x0CÂÂÂÂForm Feed
> > > +ÂÂÂÂ\rÂÂÂÂÂÂÂÂÂÂ0x0DÂÂÂÂCarriage Return
> > > +ÂÂÂÂ\vÂÂÂÂÂÂÂÂÂÂ0x0BÂÂÂÂVertical Tab
> > > +ÂÂÂÂ\"ÂÂÂÂÂÂÂÂÂÂ0x22ÂÂÂÂA literal double quote
> > > +ÂÂÂÂ\'ÂÂÂÂÂÂÂÂÂÂ0x27ÂÂÂÂA literal single quote
> > > +ÂÂÂÂ\\ÂÂÂÂÂÂÂÂÂÂ0x5CÂÂÂÂA literal backslash
> > > +ÂÂÂÂ\xXXÂÂÂÂÂÂÂÂÂÂÂÂÂÂÂÂCharacter XX in hexadecimal
> > > +ÂÂÂÂ\OOOÂÂÂÂÂÂÂÂÂÂÂÂÂÂÂÂCharacter 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 location.

Should I move the above toÂdocs/man/xl.cfg.pod.5 and apply pod markup to
it?
_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel