From: Thomas Huth <thuth@redhat.com>
To: Emanuele Giuseppe Esposito <eesposit@redhat.com>, qemu-devel@nongnu.org
Cc: Laurent Vivier <lvivier@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>
Subject: Re: [PATCH v2] libqos/qgraph: format qgraph comments for sphinx documentation
Date: Wed, 3 Mar 2021 17:43:41 +0100 [thread overview]
Message-ID: <251214bd-9676-b4fd-5592-d8efcb21a8e3@redhat.com> (raw)
In-Reply-To: <20210225122228.106305-1-eesposit@redhat.com>
On 25/02/2021 13.22, Emanuele Giuseppe Esposito wrote:
> Change documentation style and fix minor typos in tests/qtest/libqos/qgraph.h
> to automatically generate sphinx documentation in docs/devel/qgraph.rst
>
> The mechanism explanation that once was in qgraph.h is now moved to qgraph.rst
>
> There is no functional change intended.
>
> v2:
> - qgraph link visible in docs/devel/index but not in docs/index, since it is
> a subsection of qtest.
>
> Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
> ---
> MAINTAINERS | 1 +
> docs/devel/index.rst | 1 +
> docs/devel/qgraph.rst | 261 ++++++++++++++++++++++++++++++
> docs/devel/qtest.rst | 8 +
> tests/qtest/libqos/qgraph.h | 308 ++++++------------------------------
> 5 files changed, 320 insertions(+), 259 deletions(-)
> create mode 100644 docs/devel/qgraph.rst
I'm getting a bunch of warnings after applying this patch:
../tests/qtest/libqos/qgraph.h:53: warning: cannot understand function
prototype: 'struct QOSGraphEdgeOptions '
../tests/qtest/libqos/qgraph.h:93: warning: cannot understand function
prototype: 'struct QOSGraphTestOptions '
../tests/qtest/libqos/qgraph.h:138: warning: cannot understand function
prototype: 'struct QOSGraphObject '
../tests/qtest/libqos/qgraph.h:218: warning: Function parameter or member
'opts' not described in 'qos_node_create_machine_args'
../tests/qtest/libqos/qgraph.h:218: warning: Excess function parameter 'pts'
description in 'qos_node_create_machine_args'
Any chance to fix them first?
Thomas
next prev parent reply other threads:[~2021-03-03 16:45 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-25 12:22 [PATCH v2] libqos/qgraph: format qgraph comments for sphinx documentation Emanuele Giuseppe Esposito
2021-03-03 16:43 ` Thomas Huth [this message]
2021-03-04 10:33 ` Emanuele Giuseppe Esposito
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=251214bd-9676-b4fd-5592-d8efcb21a8e3@redhat.com \
--to=thuth@redhat.com \
--cc=eesposit@redhat.com \
--cc=lvivier@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).