Eric Lee / smarc-fsl-linux-kernel

Download as
Browse Code ยป

Commit 134fe01bfafa74e691d84bf15666fb30e89896ff

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 01b2d93ca4
Exists in master and in 41 other branches 8mp-imx_5.4.70_2.3.0, 8qm-imx_5.4.70_2.3.0, emb-lf-6.6.52-2.2.0-rc0, emb_imx_lf-5.15.y, emb_lf-6.1.y, emb_lf-6.6.y, imx_3.0.35_4.1.0, imx_3.10.17_1.0.1_ga, imx_3.10.53_1.1.0_ga, imx_3.14.28_1.0.0_ga, imx_4.1.15_1.0.0_ga, pitx_8mp_lf-5.10.y, rt-smarc-imx_4.1.15_1.0.0_ga, rt_linux_5.15.71, smarc-8m-android-11.0.0_2.0.0, smarc-imx6_4.14.98_2.0.0_ga, smarc-imx6_4.9.88_2.0.0_ga, smarc-imx7_4.14.98_2.0.0_ga, smarc-imx7_4.9.11_1.0.0_ga, smarc-imx7_4.9.88_2.0.0_ga, smarc-imx_3.10.53_1.1.0_ga, smarc-imx_3.14.28_1.0.0_ga, smarc-imx_4.1.15_1.0.0_ga, smarc-imx_4.9.11_1.0.0_ga, smarc-imx_4.9.51_imx8m_ga, smarc-imx_4.9.88_2.0.0_ga, smarc-m6.0.1_2.1.0-ga, smarc-n7.1.2_2.0.0-ga, smarc-rel_imx_4.1.15_1.2.0_ga, smarc_8m_00d0_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.14.78_1.0.0_ga, smarc_8m_imx_4.14.98_2.0.0_ga, smarc_8m_imx_4.19.35_1.1.0, smarc_8mm_imx_4.14.78_1.0.0_ga, smarc_8mm_imx_4.14.98_2.0.0_ga, smarc_8mm_imx_4.19.35_1.1.0, smarc_8mm_imx_5.4.24_2.1.0, smarc_8mp_lf-5.10.y, smarc_8mq_imx_5.4.24_2.1.0, smarc_8mq_lf-5.10.y, smarc_imx_lf-5.15.y

[PATCH] kernel-doc: allow unnamed structs/unions 

Make kernel-doc support unnamed (anonymous) structs and unions.  There is
one (union) in include/linux/skbuff.h (inside struct sk_buff) that is
currently generating a kernel-doc warning, so this fixes that warning.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

Showing 1 changed file with 15 additions and 2 deletions Side-by-side Diff

... ... @@ -1469,6 +1469,7 @@
1469 1469 my $param = shift;
1470 1470 my $type = shift;
1471 1471 my $file = shift;
  1472 + my $anon = 0;
1472 1473  
1473 1474 my $param_name = $param;
1474 1475 $param_name =~ s/\[.*//;
1475 1476  
... ... @@ -1484,9 +1485,20 @@
1484 1485 $param="void";
1485 1486 $parameterdescs{void} = "no arguments";
1486 1487 }
  1488 + elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
  1489 + # handle unnamed (anonymous) union or struct:
  1490 + {
  1491 + $type = $param;
  1492 + $param = "{unnamed_" . $param. "}";
  1493 + $parameterdescs{$param} = "anonymous\n";
  1494 + $anon = 1;
  1495 + }
  1496 +
1487 1497 # warn if parameter has no description
1488   - # (but ignore ones starting with # as these are no parameters
1489   - # but inline preprocessor statements
  1498 + # (but ignore ones starting with # as these are not parameters
  1499 + # but inline preprocessor statements);
  1500 + # also ignore unnamed structs/unions;
  1501 + if (!$anon) {
1490 1502 if (!defined $parameterdescs{$param_name} && $param_name !~ /^#/) {
1491 1503  
1492 1504 $parameterdescs{$param_name} = $undescribed;
... ... @@ -1499,6 +1511,7 @@
1499 1511 print STDERR "Warning(${file}:$.):".
1500 1512 " No description found for parameter '$param'\n";
1501 1513 ++$warnings;
  1514 + }
1502 1515 }
1503 1516  
1504 1517 push @parameterlist, $param;