[libvirt] [PATCHv2] docs: standardize description of flags

[Eric Blake]

On 01/09/2012 08:47 PM, Osier Yang wrote:
> On 2012年01月10日 04:59, Eric Blake wrote:
>> We had loads of different styles in describing the @flags parameter
>> for various APIs, as well as several APIs that didn't list which
>> enums provided the bit values valid for the flags.
>>
>> The end result is one of two formats:
>> @flags: bitwise-OR of vir...Flags
>> @flags: extra flags; not used yet, so callers should always pass 0
>>

>> @@ -17790,7 +17787,7 @@ error:
>>    * @params: Pointer to blkio parameter object
>>    *          (return value, allocated by the caller)
>>    * @nparams: Pointer to number of blkio parameters
>> - * @flags: An OR'ed set of virDomainModificationImpact
>> + * @flags: bitwise-OR of virDomainModificationImpact and
>> virTypedParameterFlags
>>    *
>>    * Get all block IO tunable parameters for a given device.  On input,
>>    * @nparams gives the size of the @params array; on output, @nparams
> 
> ACK.

Thanks; pushed.

-- 
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: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20120110/8ba79f7f/attachment-0001.sig>