Libguestfs - Aug 2019 - Re: [PATCH libnbd v2 1/3] generator: Implement OClosure.

On 8/13/19 10:12 AM, Richard W.M. Jones wrote:
> An optional Closure parameter, but otherwise works the same way as
> Closure.
> ---
>  generator/generator | 57 ++++++++++++++++++++++++++++++++++++---------
>  1 file changed, 46 insertions(+), 11 deletions(-)
Do we need to edit the generated documentation strings to make it
obvious that passing NULL for an OClosure function is supported (and/or
the generated string for Closure that the function must not be NULL)?

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

On Tue, Aug 13, 2019 at 10:50:09AM -0500, Eric Blake
wrote:
> On 8/13/19 10:12 AM, Richard W.M. Jones wrote:
> > An optional Closure parameter, but otherwise works the same way as
> > Closure.
> > ---
> >  generator/generator | 57
++++++++++++++++++++++++++++++++++++---------
> >  1 file changed, 46 insertions(+), 11 deletions(-)
> 
> Do we need to edit the generated documentation strings to make it
> obvious that passing NULL for an OClosure function is supported (and/or
> the generated string for Closure that the function must not be NULL)?
We should probably add that.  It would apply to other parameters as
well, eg. saying that String (const char *) cannot be NULL.  Could be
one for another patch.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
virt-top is 'top' for virtual machines.  Tiny program with many
powerful monitoring features, net stats, disk stats, logging, etc.
http://people.redhat.com/~rjones/virt-top

On 8/13/19 10:55 AM, Richard W.M. Jones wrote:
> On Tue, Aug 13, 2019 at 10:50:09AM -0500, Eric Blake wrote:
>> On 8/13/19 10:12 AM, Richard W.M. Jones wrote:
>>> An optional Closure parameter, but otherwise works the same way as
>>> Closure.
>>> ---
>>>  generator/generator | 57
++++++++++++++++++++++++++++++++++++---------
>>>  1 file changed, 46 insertions(+), 11 deletions(-)
>>
>> Do we need to edit the generated documentation strings to make it
>> obvious that passing NULL for an OClosure function is supported (and/or
>> the generated string for Closure that the function must not be NULL)?
> 
> We should probably add that.  It would apply to other parameters as
> well, eg. saying that String (const char *) cannot be NULL.  Could be
> one for another patch.
Agreed.


-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org