Re: [Qemu-devel] [PATCH v2] Fix copy&paste typos in documentation comments

["Andreas Färber" <afaerber@suse.de>]

Am 22.08.2012 17:18, schrieb BALATON Zoltan:
> 
> Signed-off-by: BALATON Zoltan <balaton@eik.bme.hu>
> ---
>  memory.h |   11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
>  v2: indented memory_region_init_ram_ptr
> 
> diff --git a/memory.h b/memory.h
> index bd1bbae..f6c8e32 100644
> --- a/memory.h
> +++ b/memory.h
> @@ -252,9 +252,9 @@ void memory_region_init_ram(MemoryRegion *mr,
>                              uint64_t size);
> 
>  /**
> - * memory_region_init_ram:  Initialize RAM memory region from a
> user-provided.
> - *                          pointer.  Accesses into the region will modify
> - *                          memory directly.
> + * memory_region_init_ram_ptr:  Initialize RAM memory region from a
> + *                              user-provided pointer.  Accesses into the
> + *                              region will modify memory directly.

@Anthony: Didn't you have a patch reformatting the whole file gtk-doc
style? My guess is, that's no longer up to date?

Apart from slightly different markup, the gtk-doc convention seems to be
to have the function name on a line of its own and the description
starting on a line of its own, not indented to the function name.
http://developer.gnome.org/gtk-doc-manual/unstable/documenting_symbols.html.en
(cf. Anthony's include/qemu/object.h)

Not objecting to this patch but questioning whether we should rebreak it
to avoid future reindenting.

@Stefan: Either way it would be nice to mention "memory" in the commit
message, please. :)

Regards,
Andreas

>   *
>   * @mr: the #MemoryRegion to be initialized.
>   * @name: the name of the region.
> @@ -581,7 +581,8 @@ void memory_region_add_subregion(MemoryRegion *mr,
>                                   target_phys_addr_t offset,
>                                   MemoryRegion *subregion);
>  /**
> - * memory_region_add_subregion: Add a subregion to a container, with
> overlap.
> + * memory_region_add_subregion_overlap: Add a subregion to a container
> + *                                      with overlap.
>   *
>   * Adds a subregion at @offset.  The subregion may overlap with other
>   * subregions.  Conflicts are resolved by having a higher @priority hide a
> @@ -743,7 +744,7 @@ void memory_listener_unregister(MemoryListener
> *listener);
>  void memory_global_dirty_log_start(void);
> 
>  /**
> - * memory_global_dirty_log_stop: begin dirty logging for all regions
> + * memory_global_dirty_log_stop: end dirty logging for all regions
>   */
>  void memory_global_dirty_log_stop(void);
> 


-- 
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer; HRB 16746 AG Nürnberg