Re: [PATCH 7/8] memory.h: Silence kernel-doc complaints

[Peter Maydell <peter.maydell@linaro.org>]

On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Fix a few instances where kernel-doc complains about doc comments
> in memory.h.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  include/exec/memory.h | 16 ++++++++++------
>  1 file changed, 10 insertions(+), 6 deletions(-)
>
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index e499dc215b..1e875996ec 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -360,10 +360,14 @@ typedef struct IOMMUMemoryRegionClass {
>  typedef struct CoalescedMemoryRange CoalescedMemoryRange;
>  typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd;
>
> +/** MemoryRegion:

Checkpatch thinks there should be a newline after the /**.

> + *
> + * A struct representing a memory region.
> + */
>  struct MemoryRegion {
>      Object parent_obj;
>
> -    /* All fields are private - violators will be prosecuted */
> +    /* private: */
>
>      /* The following fields should fit in a cache line */
>      bool romd_mode;
> @@ -452,7 +456,7 @@ struct MemoryListener {
>   * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
>   */
>  struct AddressSpace {
> -    /* All fields are private. */
> +    /* private: */
>      struct rcu_head rcu;
>      char *name;
>      MemoryRegion *root;
> @@ -1673,8 +1677,8 @@ bool memory_region_is_mapped(MemoryRegion *mr);
>   *
>   * Returns a #MemoryRegionSection that describes a contiguous overlap.
>   * It will have the following characteristics:
> - *    .@size = 0 iff no overlap was found
> - *    .@mr is non-%NULL iff an overlap was found
> + * - @size = 0 iff no overlap was found
> + * - @mr is non-%NULL iff an overlap was found
>   *
>   * Remember that in the return value the @offset_within_region is
>   * relative to the returned region (in the .@mr field), not to the
> @@ -1685,8 +1689,8 @@ bool memory_region_is_mapped(MemoryRegion *mr);
>   * returned one.  However, in the special case where the @mr argument
>   * has no container (and thus is the root of the address space), the
>   * following will hold:
> - *    .@offset_within_address_space >= @addr
> - *    .@offset_within_address_space + .@size <= @addr + @size
> + * - @offset_within_address_space >= @addr
> + * - @offset_within_address_space + .@size <= @addr + @size
>   *
>   * @mr: a MemoryRegion within which @addr is a relative address
>   * @addr: start of the area within @as to be searched
> --
> 2.21.0

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

thanks
-- PMM