Re: [libvirt] [PATCH] storage: document existing pools

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.

> + 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>?

> + 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.