[libvirt] [PATCH] esx: Improve documentation about remote URIs

[Matthias Bolte]

2010/3/13 Eric Blake <eblake at redhat.com>:
> On 03/12/2010 02:34 PM, Matthias Bolte wrote:
>> ---
>>  docs/drvesx.html.in |    8 ++++++++
>>  1 files changed, 8 insertions(+), 0 deletions(-)
>>
>> diff --git a/docs/drvesx.html.in b/docs/drvesx.html.in
>> index 9b413ab..6855298 100644
>> --- a/docs/drvesx.html.in
>> +++ b/docs/drvesx.html.in
>> @@ -32,6 +32,14 @@ gsx://example.com                  (GSX over HTTPS)
>>  esx://example.com/?transport=http  (ESX over HTTP)
>>  esx://example.com/?no_verify=1     (ESX over HTTPS, but doesn't verify the server's SSL certificate)
>>  </pre>
>> +    <p>
>> +        <strong>Note</strong>: In contrast to other drivers, the ESX driver is
>> +        a client-side-only driver. That means you cannot use the
>> +        <a href="remote.html">remote transport mechanism</a> provided by the
>> +        remote driver and libvirtd. Instead the ESX driver communicates to the
>> +        ESX server using HTTP(S). Therefore, you cannot use URIs like
>> +        <code>esx+ssh://example.com</code>.
>
> That reads awkwardly.  Might I suggest something a little more concise:
>
> In contrast to other drivers, the ESX driver is a client-side-only
> driver.  The ESX driver connects to the local ESX server using HTTP(S).
>  Therefore, the <a...>remote transport mechanism</a> provided by the
> remote driver and libvirtd will not work, and you cannot use URIs like
> <code>esx+ssh://example.com</code>.
>

Yes, that's better. I'm going to push it with a slight modification:
"It connects" instead of "The ESX driver connects" in the second
sentence, to avoid a repetition of "The ESX driver".

Thanks.

Matthias