Skip to content

Commit

Permalink
kernel-doc: Remove $decl_type='type name' hack
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ehabkost committed Oct 6, 2020
1 parent 301302f commit eb4c977
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions scripts/kernel-doc
Expand Up @@ -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(@_);
}
Expand Down Expand Up @@ -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';
Expand Down

0 comments on commit eb4c977

Please sign in to comment.