[libvirt] [PATCH] storage: document existing pools

[Eric Blake]

On 10/16/2013 05:03 AM, Ján Tomko wrote:
> On 10/16/2013 01:18 AM, Eric Blake wrote:
>> We forgot to document several pool types.  Furthermore, the
>> RNG grammar did not allow arbitrary interleaving, which makes
>> it harder than necessary to create a new pool from XML.
>>
>> * docs/formatstorage.html.in: Add docs for scsi, mpath, rbd, and
>> sheepdog.
> 
>> * docs/schemas/storagepool.rng: Allow interleaving.
>> * tests/storagepoolxml2xmlin/pool-sheepdog.xml: Test interleave.
>> * tests/storagepoolxml2xmlin/pool-iscsi-auth.xml: Likewise.
> 
> These would fit better in a separate commit IMO.

Indeed; I've split it into two.

>> +        setting of the <code>type</code> attribute (iscsi,
>> +        rbd). The <code>type</code>
> 
> In this case the sentence wasn't mentioning pools. Would "(for iscsi and rbd
> pools)" be more clear? And/or wrap all these pool names in <code>?

Good idea.  I modified the patch to call out (pool types <code>x</code>,
<code>y</code>, <code>z</code>) in each situation.

> 
>> +        must be either "chap" or "ceph". Use "ceph" for
>> +        Ceph RBD (Rados Block Device) network sources and use "iscsi" for CHAP
>> +        (Challenge-Handshake Authentication Protocol) iSCSI
>> +        targets. Additionally a mandatory attribute
>>          <code>username</code> identifies the username to use during
>>          authentication as well as a sub-element <code>secret</code> with
> 
> ACK either way.

Thanks; pushed with those improvements.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 621 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20131016/31affd12/attachment-0001.sig>