Re: [libvirt] [PATCH 10/14] lib: introduce virDomainSetLifecycleAction() API

On 10/16/2017 07:06 AM, Pavel Hrdina wrote: > Signed-off-by: Pavel Hrdina <phrdina(a)redhat.com&gt; > --- > docs/formatdomain.html.in | 6 +++++ > include/libvirt/libvirt-domain.h | 28 ++++++++++++++++++++ > src/conf/domain_conf.h | 19 -------------- > src/driver-hypervisor.h | 7 +++++ > src/libvirt-domain.c | 56 ++++++++++++++++++++++++++++++++++++++++ > src/libvirt_public.syms | 5 ++++ > src/remote/remote_driver.c | 1 + > src/remote/remote_protocol.x | 14 +++++++++- > 8 files changed, 116 insertions(+), 20 deletions(-) Of course the aforementioned src/remote_protocol-structs will be here... > > diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in > index b93ace7cba..cb19a547fe 100644 > --- a/docs/formatdomain.html.in > +++ b/docs/formatdomain.html.in > @@ -1623,6 +1623,12 @@ > </dl> > > <p> > + The lifecycle events can be configured via > + virDomainSetLifecycleAction() API > + <span class="since">since 3.9.0 (QEMU only)</span>. > + </p> s/via/via the/ s/()// Add the href like other examples, such as <a href="html/libvirt-libvirt-domain.html#virDomainSetLifecycleAction"> <code>virDomainSetLifecycleAction</code> </a>

I also don't think you can say "(QEMU only)" since the API exists in libvirt - the implementation is only on QEMU, so you have to add some text indicating not all hypervisors support. You may also want to consider text like: <span class="since">Since 3.9.0</span>, the lifecycle events can be configured via the xxx API. Not all hypervisors support all events and all actions.

I think having the since afterwards can be "confusing" sometimes, ymmv.