[libvirt] [PATCH] Generate status of the backend implementation in storage.html

[Michal Privoznik]

On 8/27/19 5:43 PM, Cedric Bosdonnat wrote:
> On Tue, 2019-08-27 at 16:38 +0200, Michal Privoznik wrote:
>> On 8/27/19 11:17 AM, Cedric Bosdonnat wrote:
>>> Since it helps a user to know which of the storage backends support
>>> what
>>> operation, include an autogenerated matrix showing it in the docs.
>>> ---
>>>    .gitignore                   |  1 +
>>>    docs/Makefile.am             |  9 +++--
>>>    docs/apibuild.py             |  2 ++
>>>    docs/storage.html.in         | 14 ++++++++
>>>    docs/storagebackendstatus.py | 64
>>> ++++++++++++++++++++++++++++++++++++
>>>    5 files changed, 88 insertions(+), 2 deletions(-)
>>>    create mode 100644 docs/storagebackendstatus.py
>>>
>>> diff --git a/docs/storage.html.in b/docs/storage.html.in
>>> index e0e4edec1e..2e4f662222 100644
>>> --- a/docs/storage.html.in
>>> +++ b/docs/storage.html.in
>>> @@ -826,5 +826,19 @@
>>>    
>>>        <h3>Valid volume format types</h3>
>>>        <p>The valid volume types are the same as for the directory
>>> pool.</p>
>>> +
>>> +    <h2>Storage Pool Types implementation status</h2>
>>> +
>>> +    <p>
>>> +      The storage backends have different level of support of the
>>> various pool and volume actions.
>>> +      Here is a matrix of the current support for each of them.
>>> +    </p>
>>> +
>>> +    <p>
>>> +      <strong>Note:</strong> some functions like Start and Stop
>>> will not trigger an exception when
>>> +      called on a backend that doesn't implement them.
>>> +    </p>
>>> +
>>> +    <div id="include" filename="storagebackendstatus.htmlinc"/>
>>>      </body>
>>>    </html>
>>
>> I feel like this belongs to hvsupport.html better. Do you have any
>> objection to that?
> 
> On one hand hvsupport.html indeed lists all the status of each
> hypervisor. But on the other hand we have a page dedicated to
> storage... Both options don't seem stupid to me.

I prefer the hvsupport page because that's where we list which APIs are 
supported by which driver and this kind of does the same. For instance, 
at hvsupport I find that virStorageVolWipe() is implemented by storage 
driver but then I'd need to swith to a different page to check what 
storage backends atually support vol wipe.

And to satisfy readers which already opened storage.html we can put a 
link to hvsupport.html#virStorageDriver or even to the matrix you're adding.

On the other hand, we can do the same for hvsupport.html so I'll leave 
that up to you.

Michal