From mboxrd@z Thu Jan  1 00:00:00 1970
From: Ian Campbell <Ian.Campbell@eu.citrix.com>
Subject: Re: [PATCH 10/14] docs: update
	xl-disk-configuration.txt to describe new syntax
Date: Fri, 20 May 2011 10:27:23 +0100
Message-ID: <1305883643.20576.11.camel@zakaz.uk.xensource.com>
References: <1305211004-31687-1-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-2-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-3-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-4-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-5-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-6-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-7-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-8-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-9-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-10-git-send-email-ian.jackson@eu.citrix.com>
	<1305211004-31687-11-git-send-email-ian.jackson@eu.citrix.com>
	<1305290747.31488.113.camel@zakaz.uk.xensource.com>
	<19923.40954.556919.444777@mariner.uk.xensource.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
Return-path: <xen-devel-bounces@lists.xensource.com>
In-Reply-To: <19923.40954.556919.444777@mariner.uk.xensource.com>
List-Unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>,
	<mailto:xen-devel-request@lists.xensource.com?subject=unsubscribe>
List-Post: <mailto:xen-devel@lists.xensource.com>
List-Help: <mailto:xen-devel-request@lists.xensource.com?subject=help>
List-Subscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>,
	<mailto:xen-devel-request@lists.xensource.com?subject=subscribe>
Sender: xen-devel-bounces@lists.xensource.com
Errors-To: xen-devel-bounces@lists.xensource.com
To: Ian Jackson <Ian.Jackson@eu.citrix.com>
Cc: "xen-devel@lists.xensource.com" <xen-devel@lists.xensource.com>
List-Id: xen-devel@lists.xenproject.org

On Wed, 2011-05-18 at 11:31 +0100, Ian Jackson wrote:
> 
> > > +where each diskspec is in this form:
> > > +
> > > +   [<key>=<value>|flag]*,
> > > +     [<target>, [<format>, [<vdev>, [<access>]]]],
> > > +     [<key>=<value>]*,
> > > +     [target=<target>]
> > 
> > The actual meaning of this is pretty opaque. The paragraphs following
> > "More formally" does a pretty good job of describing it but I still have
> > a few questions/misunderstandings.
> 
> Do you think I should get rid of this template ? 

I think it would be ok if you correct the * placements etc. Having some
sort of (semi-)formal syntax declaration in addition to the wordy
description is useful IMHO.

Would the syntax be clearer as a BNF style thing rather than a regexp-y
thing? e.g. this would allow "[<target>, [<format>, [<vdev>,
[<access>]]]]," to be declared as "POSITIONAL_PARAMETERS := ..." making
the syntax a little more self-documenting and "KEY := ..." could be
defined with reference to the relevant following sections etc.

Should the second "<key>=<value>" usage also have a "|flag"?

I presume "key" can also == "target" and can be the non-ultimate key so
long as the value does not contain any problematic characters. In this
case the explicit target= needs to be marked as optional.

Ian.