[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 20/21] kernel-doc: Remove $decl_type='type name' hack
From: |
Eduardo Habkost |
Subject: |
[PULL 20/21] kernel-doc: Remove $decl_type='type name' hack |
Date: |
Tue, 6 Oct 2020 18:09:29 -0400 |
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
- [PULL 10/21] qom: Fix DECLARE_*CHECKER documentation, (continued)
- [PULL 10/21] qom: Fix DECLARE_*CHECKER documentation, Eduardo Habkost, 2020/10/06
- [PULL 07/21] hw/core/qdev-properties: Extract system-mode specific properties, Eduardo Habkost, 2020/10/06
- [PULL 17/21] kernel-doc: Handle function typedefs without asterisks, Eduardo Habkost, 2020/10/06
- [PULL 19/21] memory: Explicitly tag doc comments for structs, Eduardo Habkost, 2020/10/06
- [PULL 11/21] docs/devel/qom: Fix indentation of bulleted list, Eduardo Habkost, 2020/10/06
- [PULL 13/21] docs/devel/qom: Use *emphasis* for emphasis, Eduardo Habkost, 2020/10/06
- [PULL 12/21] docs/devel/qom: Fix indentation of code blocks, Eduardo Habkost, 2020/10/06
- [PULL 15/21] docs/devel/qom: Avoid long lines, Eduardo Habkost, 2020/10/06
- [PULL 16/21] kernel-doc: Handle function typedefs that return pointers, Eduardo Habkost, 2020/10/06
- [PULL 21/21] numa: hmat: require parent cache description before the next level one, Eduardo Habkost, 2020/10/06
- [PULL 20/21] kernel-doc: Remove $decl_type='type name' hack,
Eduardo Habkost <=
- Re: [PULL 00/21] machine + QOM queue, 2020-10-06, Peter Maydell, 2020/10/08