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.
Signed-off-by: Eric Blake <eblake@redhat.com> --- docs/formatstorage.html.in | 44 +-- docs/schemas/storagepool.rng | 356 ++++++++++++++----------- tests/storagepoolxml2xmlin/pool-iscsi-auth.xml | 12 +- tests/storagepoolxml2xmlin/pool-sheepdog.xml | 6 +- 4 files changed, 238 insertions(+), 180 deletions(-)
@@ -128,18 +134,19 @@ <dt><code>auth</code></dt> <dd>If present, the <code>auth</code> element provides the authentication credentials needed to access the source by the - setting of the <code>type</code> attribute. The <code>type</code> - must be either "chap" or "ceph". Additionally a mandatory attribute + 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. Jan