All of lore.kernel.org
 help / color / mirror / Atom feed
From: Anthony Liguori <anthony@codemonkey.ws>
To: Kevin Wolf <kwolf@redhat.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
	Avi Kivity <avi@redhat.com>,
	qemu-devel@nongnu.org, Stefan Weil <sw@weilnetz.de>
Subject: Re: [Qemu-devel] [PATCH v2 1/4] memory: make memory API parsable by gtkdoc-scan (v2)
Date: Thu, 15 Dec 2011 07:25:28 -0600	[thread overview]
Message-ID: <4EE9F548.2080704@codemonkey.ws> (raw)
In-Reply-To: <4EE9BDAE.6060200@redhat.com>

On 12/15/2011 03:28 AM, Kevin Wolf wrote:
> Am 14.12.2011 21:01, schrieb Anthony Liguori:
>> gtkdoc-scan cannot handle nested structs so remove those from the memory API.
>>
>> Signed-off-by: Anthony Liguori<aliguori@us.ibm.com>
>
> Surely the right thing to do then is fixing gtkdoc-scan?

It's not quite that simple.  gtkdoc uses a documentation format of:

  Thing

  Longer description of thing

   - sub-bullets about things parameters and/or members
   - another sub-bullet about things parameters and/or members.

So it's expecting to deal with only one level of nesting.  You would have to 
make significant changes to deal with multiple levels of nesting.

That said, I think using an anonymous named structure for grouping is a bit 
dubious to begin with.

Regards,

Anthony Liguori

>
> Kevin
>

  reply	other threads:[~2011-12-15 13:25 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-12-14 20:01 [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2) Anthony Liguori
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 1/4] memory: make memory API parsable by gtkdoc-scan (v2) Anthony Liguori
2011-12-15  9:28   ` Kevin Wolf
2011-12-15 13:25     ` Anthony Liguori [this message]
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 2/4] docs: add build infrastructure for gtkdocs (v2) Anthony Liguori
2012-03-12 20:48   ` Eduardo Habkost
2012-03-12 23:37     ` Andreas Färber
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 3/4] memory: update documentation to be in gtk-doc format Anthony Liguori
2011-12-14 20:01 ` [Qemu-devel] [PATCH v2 4/4] memory: move header into include/ and add to QEMU docs Anthony Liguori
2011-12-14 20:54 ` [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2) Marc-André Lureau
2011-12-14 21:08   ` Anthony Liguori
2011-12-15  5:22     ` Andreas Färber
2011-12-15  9:32       ` Stefan Weil
2011-12-15 10:04         ` Daniel P. Berrange
2011-12-15 10:29           ` Stefan Weil
2011-12-15 11:36             ` Andreas Färber
2011-12-15 11:46               ` Kevin Wolf
2011-12-15 10:21         ` Kevin Wolf
2011-12-18 12:00           ` Stefan Weil
2012-03-12 21:03 ` Lluís Vilanova

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4EE9F548.2080704@codemonkey.ws \
    --to=anthony@codemonkey.ws \
    --cc=avi@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=sw@weilnetz.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.