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

2020-10-02 Thread Eduardo Habkost
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 > >^^^ thi

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

2020-10-02 Thread Paolo Bonzini
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" keyw

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

2020-10-02 Thread Eduardo Habkost
On Fri, Oct 02, 2020 at 07:43:09PM +0100, Peter Maydell wrote: > On Fri, 2 Oct 2020 at 19:35, Eduardo Habkost wrote: > > > > On Mon, Dec 02, 2019 at 06:01:16PM +, Peter Maydell wrote: > > > On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini wrote: > > > > > > > > Surprisingly, QEMU does have a prett

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

2020-10-02 Thread Peter Maydell
On Fri, 2 Oct 2020 at 19:35, Eduardo Habkost wrote: > > On Mon, Dec 02, 2019 at 06:01:16PM +, Peter Maydell wrote: > > On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini wrote: > > > > > > Surprisingly, QEMU does have a pretty consistent doc comment style and > > > it is not very different from the

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

2020-10-02 Thread Eduardo Habkost
On Mon, Dec 02, 2019 at 06:01:16PM +, Peter Maydell wrote: > On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini wrote: > > > > Surprisingly, QEMU does have a pretty consistent doc comment style and > > it is not very different from the Linux kernel's. Of the documentation > > "sigils", only "#" sepa

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

2019-12-02 Thread Paolo Bonzini
On 02/12/19 19:01, Peter Maydell wrote: >> + if (/\s*([\w\s]+?)(\s*-|:)/) { >> $identifier = $1; >> } >> >> @@ -1888,7 +1896,7 @@ sub process_name($$) { >> $contents = ""; >> $section = $section_default; >> $new_start_line = $. + 1; >> - if (/

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

2019-12-02 Thread Peter Maydell
On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini wrote: > > Surprisingly, QEMU does have a pretty consistent doc comment style and > it is not very different from the Linux kernel's. Of the documentation > "sigils", only "#" separates the QEMU doc comment style from Linux's, > and it has 200+ instance

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

2019-11-29 Thread Paolo Bonzini
Surprisingly, QEMU does have a pretty consistent doc comment style and it is not very different from the Linux kernel's. Of the documentation "sigils", only "#" separates the QEMU doc comment style from Linux's, and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in accel/tcg/trans