Re: [Xen-devel] [PATCH 2 of 4 v3] blkif.h: Provide more complete documentation of the blkif interface

["Justin T. Gibbs" <justing@xxxxxxxxxxxxxxxx>]

On Feb 21, 2012, at 7:27 AM, Ian Campbell wrote:

> On Mon, 2012-02-20 at 18:07 +0000, Justin T. Gibbs wrote:
>> o Document the XenBus nodes used in this protocol.
>>  o Add a state diagram illustrating the roles and responsibilities
>>    of both the front and backend during startup.
>>  o Correct missed BLKIF_OP_TRIM => BLKIF_OP_DISCARD conversion in a comment.
>> 
>> No functional changes.
>> 
>> Signed-off-by: Justin T. Gibbs <justing@xxxxxxxxxxxxxxxx>
> 
> Acked-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
> 
> I've made some very minor comments below but I think getting the basic
> documentation of this stuff in as a baseline to improve and correct over
> time is more important than any of them.
> 
> Thanks again for doing this -- it is really valuable!

Thanks.

>> + * params
>> + *      Values:         string
>> + *
>> + *      A free formatted string providing sufficient information for the
>> + *      backend driver to open the backing device.  (e.g. the path to the
>> + *      file or block device representing the backing store.)
> 
> The syntax and semantics of params is defined by the particular backend,
> rather than being "free formatted" as such. I think it would be worth
> saying that explicitly.
> 
> Ian.

Perhaps something like this?

 * params                                                               
 *      Values:         string                                               
 *                                                                   
 *      Data used by the backend driver to locate and configure the backing
 *      device.  The format and semantics of this data vary according to the 
 *      backing device in use and are outside the scope of this specification.

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