From: Eduardo Habkost <ehabkost@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>
Subject: [PULL 20/21] kernel-doc: Remove $decl_type='type name' hack
Date: Tue, 6 Oct 2020 18:09:29 -0400 [thread overview]
Message-ID: <20201006220930.908275-21-ehabkost@redhat.com> (raw)
In-Reply-To: <20201006220930.908275-1-ehabkost@redhat.com>
The $decl_type='type name' hack makes it impossible to document
macros with uppercase names (e.g. most of the macros in
object.h).
Now that we have explicitly tagged the struct and typedef doc
comments in memory.h and object.h, we don't need that hack
anymore. This will make the documentation for the macros in
object.h finally be rendered as expected.
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20201003024123.193840-6-ehabkost@redhat.com>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
scripts/kernel-doc | 12 +-----------
1 file changed, 1 insertion(+), 11 deletions(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 57b911ff17..0ff62bb6a2 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1064,14 +1064,6 @@ sub output_blockhead {
sub dump_declaration($$) {
no strict 'refs';
my ($prototype, $file) = @_;
- if ($decl_type eq 'type name') {
- if ($prototype =~ /^(enum|struct|union)\s+/) {
- $decl_type = $1;
- } else {
- return;
- }
- }
-
my $func = "dump_" . $decl_type;
&$func(@_);
}
@@ -1928,9 +1920,7 @@ sub process_name($$) {
++$warnings;
}
- if ($identifier =~ m/^[A-Z]/) {
- $decl_type = 'type name';
- } elsif ($identifier =~ m/^struct\b/) {
+ if ($identifier =~ m/^struct\b/) {
$decl_type = 'struct';
} elsif ($identifier =~ m/^union\b/) {
$decl_type = 'union';
--
2.26.2
next prev parent reply other threads:[~2020-10-06 22:25 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-06 22:09 [PULL 00/21] machine + QOM queue, 2020-10-06 Eduardo Habkost
2020-10-06 22:09 ` [PULL 01/21] hw/core/qdev-properties: Use qemu_strtol() in set_mac() handler Eduardo Habkost
2020-10-06 22:09 ` [PULL 02/21] hw/core/qdev-properties: Use qemu_strtoul() in set_pci_host_devaddr() Eduardo Habkost
2020-10-06 22:09 ` [PULL 03/21] hw/core/qdev-properties: Fix code style Eduardo Habkost
2020-10-06 22:09 ` [PULL 04/21] hw/core/qdev-properties: Export enum-related functions Eduardo Habkost
2020-10-06 22:09 ` [PULL 05/21] hw/core/qdev-properties: Export qdev_prop_enum Eduardo Habkost
2020-10-06 22:09 ` [PULL 06/21] hw/core/qdev-properties: Export some integer-related functions Eduardo Habkost
2020-10-06 22:09 ` [PULL 07/21] hw/core/qdev-properties: Extract system-mode specific properties Eduardo Habkost
2020-10-06 22:09 ` [PULL 08/21] hw/core/cpu: Add missing 'exec/cpu-common.h' include Eduardo Habkost
2020-10-06 22:09 ` [PULL 09/21] qom: Improve error message displayed with missing object properties Eduardo Habkost
2020-10-06 22:09 ` [PULL 10/21] qom: Fix DECLARE_*CHECKER documentation Eduardo Habkost
2020-10-06 22:09 ` [PULL 11/21] docs/devel/qom: Fix indentation of bulleted list Eduardo Habkost
2020-10-06 22:09 ` [PULL 12/21] docs/devel/qom: Fix indentation of code blocks Eduardo Habkost
2020-10-06 22:09 ` [PULL 13/21] docs/devel/qom: Use *emphasis* for emphasis Eduardo Habkost
2020-10-06 22:09 ` [PULL 14/21] docs/devel/qom: Remove usage of <code> Eduardo Habkost
2020-10-06 22:09 ` [PULL 15/21] docs/devel/qom: Avoid long lines Eduardo Habkost
2020-10-06 22:09 ` [PULL 16/21] kernel-doc: Handle function typedefs that return pointers Eduardo Habkost
2020-10-06 22:09 ` [PULL 17/21] kernel-doc: Handle function typedefs without asterisks Eduardo Habkost
2020-10-06 22:09 ` [PULL 18/21] qom: Explicitly tag doc comments for typedefs and structs Eduardo Habkost
2020-10-06 22:09 ` [PULL 19/21] memory: Explicitly tag doc comments for structs Eduardo Habkost
2020-10-06 22:09 ` Eduardo Habkost [this message]
2020-10-06 22:09 ` [PULL 21/21] numa: hmat: require parent cache description before the next level one Eduardo Habkost
2020-10-08 14:26 ` [PULL 00/21] machine + QOM queue, 2020-10-06 Peter Maydell
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=20201006220930.908275-21-ehabkost@redhat.com \
--to=ehabkost@redhat.com \
--cc=berrange@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--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).