Re: [Qemu-devel] [PATCH 05/29] memory: differentiate memory_region_is_logging and memory_region_get_dirty_log_mask

[Paolo Bonzini]

On 26/05/2015 09:46, Fam Zheng wrote:
>> >   *
>> > - * Returns %true if the memory region is logging writes
>> > + * Returns %true if the memory region is logging writes for the given 
>> > client
>> > + * a bitmap of clients for which the memory region is logging writes.
> I can't parse this sentence, rephrase a bit?

The second line is stail

>> >   *
>> >   * @mr: the memory region being queried
>> > + * @client: the client being queried
>> >   */
>> > -bool memory_region_is_logging(MemoryRegion *mr);
>> > +bool memory_region_is_logging(MemoryRegion *mr, uint8_t client);
>> > +
>> > +/**
>> > + * memory_region_get_dirty_log_mask: return the clients for which a
> s/which a/ which the/ ?

"a" is consistent with "memory_region_name: get a memory region's name",
for example.

>> > + * memory region is logging writes.
>> > + *
>> > + * Returns a bitmap of clients for which the memory region is logging 
>> > writes.
> Why repeat?

Just a consequence of how the doc comments are written.  For some
functions the summary is the same as the description of the return
value.  I'll change it to just "Returns a bitmap of clients, which right
now will be either 0 or (1 << DIRTY_MEMORY_VGA)".

Paolo

> All questions are trivial enough that once you fix them or if they don't need
> fixing:
> 
> Reviewed-by: Fam Zheng <address@hidden>
>