[libvirt] [PATCH] docs: rudimentary phyp documentation

[Eric Blake]

On 10/01/2012 07:46 AM, Eduardo Otubo wrote:
> On Thu, Sep 27, 2012 at 04:23:22PM -0600, Eric Blake wrote:
>> Based on a report that phyp is undocumented:
>> https://www.redhat.com/archives/libvirt-users/2012-July/msg00013.html
>>
>> * docs/drvphyp.html.in (phyp): New file.
>> * docs/drivers.html.in: List it.
>> ---
>>
>> +        <strong>Note</strong>: In contrast to other drivers, the
>> +        PowerVM (or phyp) driver is a client-side-only driver. Therefore, the
>> +        <a href="remote.html">remote transport mechanism</a> provided by the
>> +        remote driver and libvirtd will not work, and you cannot use URIs like
>> +        <code>phyp+ssh://example.com</code>.
>> +    </p>
> 
> I think it whould be interesting to point that phyp uses ssh internally,
> so phyp+ssh would be redundant.

Added.

> 
>> +
>> +
>> +    <h3><a name="uriformat">URI Format</a></h3>
>> +    <p>
>> +        URIs have this general form (<code>[...]</code> marks an
>> +        optional part, <code>{...|...}</code> marks a mandatory choice).
>> +    </p>
>> +<pre>
>> +phyp://[username@]{hmc|ivm}/managed_system
> 
> Actually, in the entire phyp URI is mandatory, the correct way should be:
> 
> phyp://username@{hmc|ivm}/managed_system
> 
> Or are you assuming that the username can be used from environment
> variable like in ssh?

username SHOULD be optional (and default to the current user, as in
ssh); if the code doesn't do that, you are welcome to write a patch.

At any rate, I've pushed this, as partial documentation is better than
no documentation.

-- 
Eric Blake   eblake at 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: 617 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20121003/fba2bc75/attachment-0001.sig>