aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2017-11-24 02:01:32 -0500
committerLinus Torvalds <torvalds@linux-foundation.org>2017-11-24 02:01:32 -0500
commit1d3bc6363a7d14393e7e66f092645e2229b39954 (patch)
tree53bbedd96014f2a04cb853140868d3d739658f6f /scripts/kernel-doc
parentdab0badc8735f4e8bf07bc56bdeefce91d413924 (diff)
parent3a025e1d1c2ea42fa497c9c6b21c284e0f69e28b (diff)
Merge tag 'docs-4.15-2' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "A few late-arriving docs updates that have no real reason to wait. There's a new "Co-Developed-by" tag described by Greg, and a build enhancement from Willy to generate docs warnings during a kernel build (but only when additional warnings have been requested in general)" * tag 'docs-4.15-2' of git://git.lwn.net/linux: Add optional check for bad kernel-doc comments Documentation: fix profile= options in kernel-parameters.txt documentation/svga.txt: update outdated file kokr/memory-barriers.txt: Fix typo in paring example kokr/memory-barriers/txt: Replace uses of "transitive" Documentation/process: add Co-Developed-by: tag for patches with multiple authors
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc25
1 files changed, 24 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 7bd52b8f63d4..bd29a92b4b48 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -58,6 +58,7 @@ Output format selection (mutually exclusive):
58 -man Output troff manual page format. This is the default. 58 -man Output troff manual page format. This is the default.
59 -rst Output reStructuredText format. 59 -rst Output reStructuredText format.
60 -text Output plain text format. 60 -text Output plain text format.
61 -none Do not output documentation, only warnings.
61 62
62Output selection (mutually exclusive): 63Output selection (mutually exclusive):
63 -export Only output documentation for symbols that have been 64 -export Only output documentation for symbols that have been
@@ -532,6 +533,8 @@ while ($ARGV[0] =~ m/^-(.*)/) {
532 $output_mode = "gnome"; 533 $output_mode = "gnome";
533 @highlights = @highlights_gnome; 534 @highlights = @highlights_gnome;
534 $blankline = $blankline_gnome; 535 $blankline = $blankline_gnome;
536 } elsif ($cmd eq "-none") {
537 $output_mode = "none";
535 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document 538 } elsif ($cmd eq "-module") { # not needed for XML, inherits from calling document
536 $modulename = shift @ARGV; 539 $modulename = shift @ARGV;
537 } elsif ($cmd eq "-function") { # to only output specific functions 540 } elsif ($cmd eq "-function") { # to only output specific functions
@@ -2117,6 +2120,24 @@ sub output_blockhead_list(%) {
2117 } 2120 }
2118} 2121}
2119 2122
2123
2124## none mode output functions
2125
2126sub output_function_none(%) {
2127}
2128
2129sub output_enum_none(%) {
2130}
2131
2132sub output_typedef_none(%) {
2133}
2134
2135sub output_struct_none(%) {
2136}
2137
2138sub output_blockhead_none(%) {
2139}
2140
2120## 2141##
2121# generic output function for all types (function, struct/union, typedef, enum); 2142# generic output function for all types (function, struct/union, typedef, enum);
2122# calls the generated, variable output_ function name based on 2143# calls the generated, variable output_ function name based on
@@ -3143,7 +3164,9 @@ sub process_file($) {
3143 } 3164 }
3144 } 3165 }
3145 if ($initial_section_counter == $section_counter) { 3166 if ($initial_section_counter == $section_counter) {
3146 print STDERR "${file}:1: warning: no structured comments found\n"; 3167 if ($output_mode ne "none") {
3168 print STDERR "${file}:1: warning: no structured comments found\n";
3169 }
3147 if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) { 3170 if (($output_selection == OUTPUT_INCLUDE) && ($show_not_found == 1)) {
3148 print STDERR " Was looking for '$_'.\n" for keys %function_table; 3171 print STDERR " Was looking for '$_'.\n" for keys %function_table;
3149 } 3172 }