qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards


From: Eduardo Habkost
Subject: Re: [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards
Date: Fri, 2 Oct 2020 15:18:31 -0400

On Fri, Oct 02, 2020 at 08:50:22PM +0200, Paolo Bonzini wrote:
> On 02/10/20 20:46, Eduardo Habkost wrote:
> > This is not the code that parses "#MemoryRegionSection", it is
> > the code that parses:
> > 
> > /**
> >  * MemoryRegionSection: describes a fragment of a #MemoryRegion
> >    ^^^^^^^ this line
> 
> We can probably just adjust the comments to include the "struct" keyword
> first.  There aren't that many, (un)fortunately.
> 
> It may even be possible to print to stderr the file and line number so
> that the script tells us where the hack is firing.
> 

There are 3 lines where the hack is correctly triggered, but we
can just change it to use "struct MyTypeName" instead:

include/exec/memory.h:681: HERE
include/exec/memory.h:699: HERE
include/exec/memory.h:743: HERE

And 29 lines where it's probably being triggered by mistake:

include/qom/object.h:47: HERE
include/qom/object.h:66: HERE
include/qom/object.h:78: HERE
include/qom/object.h:87: HERE
include/qom/object.h:110: HERE
include/qom/object.h:118: HERE
include/qom/object.h:140: HERE
include/qom/object.h:162: HERE
include/qom/object.h:179: HERE
include/qom/object.h:200: HERE
include/qom/object.h:218: HERE
include/qom/object.h:241: HERE
include/qom/object.h:259: HERE
include/qom/object.h:313: HERE
include/qom/object.h:330: HERE
include/qom/object.h:353: HERE
include/qom/object.h:370: HERE
include/qom/object.h:432: HERE
include/qom/object.h:442: HERE
include/qom/object.h:452: HERE
include/qom/object.h:469: HERE
include/qom/object.h:483: HERE
include/qom/object.h:496: HERE
include/qom/object.h:506: HERE
include/qom/object.h:521: HERE
include/qom/object.h:531: HERE
include/qom/object.h:543: HERE
include/qom/object.h:861: HERE

-- 
Eduardo




reply via email to

[Prev in Thread] Current Thread [Next in Thread]