[libvirt] [PATCH 05/10] docs: storage: Document <auth> element

[Cole Robinson]

On 02/23/2010 02:51 AM, Daniel P. Berrange wrote:
> On Mon, Feb 22, 2010 at 05:10:53PM -0500, Cole Robinson wrote:
>>
>> Signed-off-by: Cole Robinson <crobinso at redhat.com>
>> ---
>>  docs/formatstorage.html.in |    8 ++++++++
>>  docs/storage.html.in       |    1 +
>>  2 files changed, 9 insertions(+), 0 deletions(-)
>>
>> diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
>> index 7ececed..855d475 100644
>> --- a/docs/formatstorage.html.in
>> +++ b/docs/formatstorage.html.in
>> @@ -70,6 +70,7 @@
>>          <source>
>>            <host name="iscsi.example.com"/>
>>            <device path="demo-target"/>
>> +          <auth type="chap" login="foobar" passwd="foo-passwd"/>
>>          </source>
>>          ...</pre>
>>  
>> @@ -103,6 +104,13 @@
>>          type, or network filesystem type, or partition table type, or
>>          LVM metadata type. All drivers are required to have a default
>>          value for this, so it is optional. <span class="since">Since 0.4.1</span></dd>
>> +      <dt><code>auth</code></dt>
>> +      <dd>Provides login information for an iSCSI pools server.
>> +      <code>type</code> is a required attribute which specifies the
>> +      authentication method. Currently only <code>chap</code>
>> +      (challenge-handshake) is supported. <code>login</code> and
>> +      <code>passwd</code> specify the login and password respectively.
>> +        <span class="since">Since 0.4.1</span></dd>
>>      </dl>
>>  
>>      <h3><a name="StoragePoolTarget">Target elements</a></h3>
> 
> Our iSCSI backend never actually implemented any of this, so its a little
> bit misleading & probably a bad idea in the XML in any case. I'm inclined
> to actually remove this from the XML parser since it was never used.
> 

Huh, I never actually confirmed it worked :) Figuring that the XML
generation was broken for this up until 0.7.2 I believe, there is
probably no harm in removing it. I'll cook up a patch.

Thanks,
Cole