blob: aea04365bc69d38617aed7826a172ab6b1b7f9ec [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Jonathan Corbet38476372018-02-20 12:24:23 -07002# SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02004use warnings;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005use strict;
6
7## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
8## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
9## Copyright (C) 2001 Simon Huggins ##
Randy Dunlap70c95b02012-01-21 10:31:54 -080010## Copyright (C) 2005-2012 Randy Dunlap ##
Dan Luedtke1b40c192012-08-12 10:46:15 +020011## Copyright (C) 2012 Dan Luedtke ##
Linus Torvalds1da177e2005-04-16 15:20:36 -070012## ##
13## #define enhancements by Armin Kuster <akuster@mvista.com> ##
14## Copyright (c) 2000 MontaVista Software, Inc. ##
Tomasz Warniełło2b306ec2022-02-18 19:16:28 +010015#
16# Copyright (C) 2022 Tomasz Warniełło (POD)
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Tomasz Warniełło43caf1a2022-02-18 19:16:19 +010018use Pod::Usage qw/pod2usage/;
19
Tomasz Warniełłoa5cdaea2022-02-18 19:16:18 +010020=head1 NAME
21
22kernel-doc - Print formatted kernel documentation to stdout
23
24=head1 SYNOPSIS
25
26 kernel-doc [-h] [-v] [-Werror]
27 [ -man |
28 -rst [-sphinx-version VERSION] [-enable-lineno] |
29 -none
30 ]
31 [
32 -export |
33 -internal |
34 [-function NAME] ... |
35 [-nosymbol NAME] ...
36 ]
37 [-no-doc-sections]
38 [-export-file FILE] ...
39 FILE ...
40
41Run `kernel-doc -h` for details.
42
Tomasz Warniełłof1583922022-02-18 19:16:20 +010043=head1 DESCRIPTION
44
45Read C language source or header FILEs, extract embedded documentation comments,
46and print formatted documentation to standard output.
47
48The documentation comments are identified by the "/**" opening comment mark.
49
50See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax.
51
Tomasz Warniełłoa5cdaea2022-02-18 19:16:18 +010052=cut
53
Tomasz Warniełło2875f782022-02-18 19:16:21 +010054# more perldoc at the end of the file
55
Randy Dunlap8484baa2011-01-05 16:28:43 -080056## init lots of data
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058my $errors = 0;
59my $warnings = 0;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -070060my $anon_struct_union = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62# match expressions used to find embedded type information
Mauro Carvalho Chehabb97f1932017-03-30 17:11:28 -030063my $type_constant = '\b``([^\`]+)``\b';
64my $type_constant2 = '\%([-_\w]+)';
Linus Torvalds1da177e2005-04-16 15:20:36 -070065my $type_func = '(\w+)\(\)';
Mike Rapoportbfd228c2018-11-07 18:47:13 +020066my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
Mauro Carvalho Chehabee2aa752020-04-14 18:48:28 +020067my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
Jonathan Corbet5219f182016-08-24 16:31:15 -060068my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params
Mauro Carvalho Chehab346282d2020-04-14 18:48:27 +020069my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params
Linus Torvalds1da177e2005-04-16 15:20:36 -070070my $type_env = '(\$\w+)';
Paolo Bonzinidf311752017-01-02 16:22:27 +010071my $type_enum = '\&(enum\s*([_\w]+))';
72my $type_struct = '\&(struct\s*([_\w]+))';
73my $type_typedef = '\&(typedef\s*([_\w]+))';
74my $type_union = '\&(union\s*([_\w]+))';
Paolo Bonzini5267dd32017-01-02 16:22:26 +010075my $type_member = '\&([_\w]+)(\.|->)([_\w]+)';
Paolo Bonzinidf311752017-01-02 16:22:27 +010076my $type_fallback = '\&([_\w]+)';
Jani Nikulaf3341dc2016-05-26 16:35:02 +030077my $type_member_func = $type_member . '\(\)';
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79# Output conversion substitutions.
80# One for each output format
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082# these are pretty rough
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -030083my @highlights_man = (
84 [$type_constant, "\$1"],
Mauro Carvalho Chehabb97f1932017-03-30 17:11:28 -030085 [$type_constant2, "\$1"],
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -030086 [$type_func, "\\\\fB\$1\\\\fP"],
Paolo Bonzinidf311752017-01-02 16:22:27 +010087 [$type_enum, "\\\\fI\$1\\\\fP"],
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -030088 [$type_struct, "\\\\fI\$1\\\\fP"],
Paolo Bonzinidf311752017-01-02 16:22:27 +010089 [$type_typedef, "\\\\fI\$1\\\\fP"],
90 [$type_union, "\\\\fI\$1\\\\fP"],
Paolo Bonzini5267dd32017-01-02 16:22:26 +010091 [$type_param, "\\\\fI\$1\\\\fP"],
Mauro Carvalho Chehabee2aa752020-04-14 18:48:28 +020092 [$type_param_ref, "\\\\fI\$1\$2\\\\fP"],
Paolo Bonzinidf311752017-01-02 16:22:27 +010093 [$type_member, "\\\\fI\$1\$2\$3\\\\fP"],
94 [$type_fallback, "\\\\fI\$1\\\\fP"]
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -030095 );
Linus Torvalds1da177e2005-04-16 15:20:36 -070096my $blankline_man = "";
97
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +030098# rst-mode
99my @highlights_rst = (
100 [$type_constant, "``\$1``"],
Mauro Carvalho Chehabb97f1932017-03-30 17:11:28 -0300101 [$type_constant2, "``\$1``"],
Jani Nikulaf3341dc2016-05-26 16:35:02 +0300102 # Note: need to escape () to avoid func matching later
Paolo Bonzini5267dd32017-01-02 16:22:26 +0100103 [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\\\\) <\$1>`"],
104 [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"],
Jonathan Corbet5219f182016-08-24 16:31:15 -0600105 [$type_fp_param, "**\$1\\\\(\\\\)**"],
Mauro Carvalho Chehab346282d2020-04-14 18:48:27 +0200106 [$type_fp_param2, "**\$1\\\\(\\\\)**"],
Jonathan Corbet344fdb22019-06-21 17:34:30 -0600107 [$type_func, "\$1()"],
Paolo Bonzinidf311752017-01-02 16:22:27 +0100108 [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"],
109 [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"],
110 [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"],
111 [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"],
Jani Nikulaa7291e72016-05-26 13:57:06 +0300112 # in rst this can refer to any type
Paolo Bonzinidf311752017-01-02 16:22:27 +0100113 [$type_fallback, "\\:c\\:type\\:`\$1`"],
Mauro Carvalho Chehabee2aa752020-04-14 18:48:28 +0200114 [$type_param_ref, "**\$1\$2**"]
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300115 );
116my $blankline_rst = "\n";
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118# read arguments
Randy Dunlapb9d973282009-06-09 08:50:38 -0700119if ($#ARGV == -1) {
Tomasz Warniełło43caf1a2022-02-18 19:16:19 +0100120 pod2usage(
121 -message => "No arguments!\n",
122 -exitval => 1,
123 -verbose => 99,
124 -sections => 'SYNOPSIS',
125 -output => \*STDERR,
126 );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127}
128
Randy Dunlap8484baa2011-01-05 16:28:43 -0800129my $kernelversion;
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +0200130my ($sphinx_major, $sphinx_minor, $sphinx_patch);
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200131
Randy Dunlap8484baa2011-01-05 16:28:43 -0800132my $dohighlight = "";
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134my $verbose = 0;
Pierre-Louis Bossart2c12c812020-07-28 11:20:40 -0500135my $Werror = 0;
Mauro Carvalho Chehabbdfe2be2017-12-18 10:30:11 -0200136my $output_mode = "rst";
Daniel Santose314ba32012-10-04 17:15:08 -0700137my $output_preformatted = 0;
Johannes Berg4b445952007-10-24 15:08:48 -0700138my $no_doc_sections = 0;
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200139my $enable_lineno = 0;
Mauro Carvalho Chehabbdfe2be2017-12-18 10:30:11 -0200140my @highlights = @highlights_rst;
141my $blankline = $blankline_rst;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142my $modulename = "Kernel API";
Jani Nikulab6c3f452016-05-29 22:19:35 +0300143
144use constant {
145 OUTPUT_ALL => 0, # output all symbols and doc sections
146 OUTPUT_INCLUDE => 1, # output only specified symbols
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200147 OUTPUT_EXPORTED => 2, # output exported symbols
148 OUTPUT_INTERNAL => 3, # output non-exported symbols
Jani Nikulab6c3f452016-05-29 22:19:35 +0300149};
150my $output_selection = OUTPUT_ALL;
Jonathan Corbetb0d60bf2019-05-24 14:52:01 -0600151my $show_not_found = 0; # No longer used
Ben Hutchingsb2c41052015-07-08 20:07:16 +0100152
Jani Nikula88c2b572016-06-07 11:00:52 +0300153my @export_file_list;
154
Ben Hutchingsb2c41052015-07-08 20:07:16 +0100155my @build_time;
156if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) &&
157 (my $seconds = `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '') {
158 @build_time = gmtime($seconds);
159} else {
160 @build_time = localtime;
161}
162
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800163my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
164 'July', 'August', 'September', 'October',
Ben Hutchingsb2c41052015-07-08 20:07:16 +0100165 'November', 'December')[$build_time[4]] .
166 " " . ($build_time[5]+1900);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Randy Dunlap8484baa2011-01-05 16:28:43 -0800168# Essentially these are globals.
Randy Dunlapb9d973282009-06-09 08:50:38 -0700169# They probably want to be tidied up, made more localised or something.
170# CAVEAT EMPTOR! Some of the others I localised may not want to be, which
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171# could cause "use of undefined value" or other bugs.
Randy Dunlapb9d973282009-06-09 08:50:38 -0700172my ($function, %function_table, %parametertypes, $declaration_purpose);
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200173my %nosymbol_table = ();
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200174my $declaration_start_line;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700175my ($type, $declaration_name, $return_type);
Ilya Dryomov1c32fd02010-02-26 13:06:03 -0800176my ($newsection, $newcontents, $prototype, $brcount, %source_map);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Randy Dunlapbd0e88e2008-03-13 12:32:43 -0700178if (defined($ENV{'KBUILD_VERBOSE'})) {
179 $verbose = "$ENV{'KBUILD_VERBOSE'}";
180}
181
Pierre-Louis Bossart2c12c812020-07-28 11:20:40 -0500182if (defined($ENV{'KCFLAGS'})) {
183 my $kcflags = "$ENV{'KCFLAGS'}";
184
185 if ($kcflags =~ /Werror/) {
186 $Werror = 1;
187 }
188}
189
Laurent Pinchartbed4ed32021-07-31 01:54:01 +0300190if (defined($ENV{'KDOC_WERROR'})) {
191 $Werror = "$ENV{'KDOC_WERROR'}";
192}
193
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800194# Generated docbook code is inserted in a template at a point where
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
Alexander A. Klimov93431e02020-05-26 08:05:44 +0200196# https://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197# We keep track of number of generated entries and generate a dummy
198# if needs be to ensure the expanded template can be postprocessed
199# into html.
200my $section_counter = 0;
201
202my $lineprefix="";
203
Jani Nikula48af6062016-05-26 14:56:05 +0300204# Parser states
205use constant {
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +0200206 STATE_NORMAL => 0, # normal code
207 STATE_NAME => 1, # looking for function name
208 STATE_BODY_MAYBE => 2, # body - or maybe more description
209 STATE_BODY => 3, # the body of the comment
210 STATE_BODY_WITH_BLANK_LINE => 4, # the body, which has a blank line
211 STATE_PROTO => 5, # scanning prototype
212 STATE_DOCBLOCK => 6, # documentation block
213 STATE_INLINE => 7, # gathering doc outside main block
Jani Nikula48af6062016-05-26 14:56:05 +0300214};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215my $state;
Randy Dunlap850622d2006-06-25 05:48:55 -0700216my $in_doc_sect;
Jonathan Corbetd742f242018-02-05 15:36:05 -0700217my $leading_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Jani Nikula48af6062016-05-26 14:56:05 +0300219# Inline documentation state
220use constant {
221 STATE_INLINE_NA => 0, # not applicable ($state != STATE_INLINE)
222 STATE_INLINE_NAME => 1, # looking for member name (@foo:)
223 STATE_INLINE_TEXT => 2, # looking for member documentation
224 STATE_INLINE_END => 3, # done
225 STATE_INLINE_ERROR => 4, # error - Comment without header was found.
226 # Spit a warning as it's not
227 # proper kernel-doc and ignore the rest.
228};
229my $inline_doc_state;
Danilo Cesar Lemes de Paulaa4c6ebe2015-08-04 09:04:08 -0300230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231#declaration types: can be
232# 'function', 'struct', 'union', 'enum', 'typedef'
233my $decl_type;
234
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +0100235# Name of the kernel-doc identifier for non-DOC markups
236my $identifier;
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
239my $doc_end = '\*/';
240my $doc_com = '\s*\*\s*';
Daniel Santos12ae6772012-10-04 17:15:10 -0700241my $doc_com_body = '\s*\* ?';
Randy Dunlapb9d973282009-06-09 08:50:38 -0700242my $doc_decl = $doc_com . '(\w+)';
Jani Nikulaf624ade2016-05-29 11:35:28 +0300243# @params and a strictly limited set of supported section names
Jonathan Corbet212209cf2021-03-26 13:16:35 -0600244# Specifically:
245# Match @word:
246# @...:
247# @{section-name}:
248# while trying to not match literal block starts like "example::"
249#
Mike Rapoport76dd3e72018-11-07 18:47:12 +0200250my $doc_sect = $doc_com .
Jonathan Corbet212209cf2021-03-26 13:16:35 -0600251 '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$';
Daniel Santos12ae6772012-10-04 17:15:10 -0700252my $doc_content = $doc_com_body . '(.*)';
Randy Dunlapb9d973282009-06-09 08:50:38 -0700253my $doc_block = $doc_com . 'DOC:\s*(.*)?';
Jani Nikula48af6062016-05-26 14:56:05 +0300254my $doc_inline_start = '^\s*/\*\*\s*$';
Mauro Carvalho Chehabfe7bc492018-02-16 11:48:18 -0200255my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
Jani Nikula48af6062016-05-26 14:56:05 +0300256my $doc_inline_end = '^\s*\*/\s*$';
Jani Nikula0c9aa202016-11-16 17:26:16 +0200257my $doc_inline_oneline = '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$';
Jani Nikula86ae2e32016-01-21 13:05:22 +0200258my $export_symbol = '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;';
Aditya Srivastavae86bdb22021-05-14 20:12:44 +0530259my $function_pointer = qr{([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)};
260my $attribute = qr{__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)}i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262my %parameterdescs;
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200263my %parameterdesc_start_lines;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264my @parameterlist;
265my %sections;
266my @sectionlist;
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200267my %section_start_lines;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800268my $sectcheck;
269my $struct_actual;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271my $contents = "";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200272my $new_start_line = 0;
Jani Nikulaf624ade2016-05-29 11:35:28 +0300273
274# the canonical section names. see also $doc_sect above.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275my $section_default = "Description"; # default section
276my $section_intro = "Introduction";
277my $section = $section_default;
278my $section_context = "Context";
Yacine Belkadi4092bac2012-11-26 22:22:27 +0100279my $section_return = "Return";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281my $undescribed = "-- undescribed --";
282
283reset_state();
284
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200285while ($ARGV[0] =~ m/^--?(.*)/) {
286 my $cmd = $1;
287 shift @ARGV;
288 if ($cmd eq "man") {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 $output_mode = "man";
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -0300290 @highlights = @highlights_man;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 $blankline = $blankline_man;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200292 } elsif ($cmd eq "rst") {
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300293 $output_mode = "rst";
294 @highlights = @highlights_rst;
295 $blankline = $blankline_rst;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200296 } elsif ($cmd eq "none") {
Matthew Wilcox3a025e12017-11-20 10:40:40 -0800297 $output_mode = "none";
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200298 } elsif ($cmd eq "module") { # not needed for XML, inherits from calling document
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 $modulename = shift @ARGV;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200300 } elsif ($cmd eq "function") { # to only output specific functions
Jani Nikulab6c3f452016-05-29 22:19:35 +0300301 $output_selection = OUTPUT_INCLUDE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 $function = shift @ARGV;
303 $function_table{$function} = 1;
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200304 } elsif ($cmd eq "nosymbol") { # Exclude specific symbols
305 my $symbol = shift @ARGV;
306 $nosymbol_table{$symbol} = 1;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200307 } elsif ($cmd eq "export") { # only exported symbols
Jani Nikulab6c3f452016-05-29 22:19:35 +0300308 $output_selection = OUTPUT_EXPORTED;
Jani Nikulada9726e2016-06-07 10:29:59 +0300309 %function_table = ();
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200310 } elsif ($cmd eq "internal") { # only non-exported symbols
Jani Nikulab6c3f452016-05-29 22:19:35 +0300311 $output_selection = OUTPUT_INTERNAL;
Jani Nikulada9726e2016-06-07 10:29:59 +0300312 %function_table = ();
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200313 } elsif ($cmd eq "export-file") {
Jani Nikula88c2b572016-06-07 11:00:52 +0300314 my $file = shift @ARGV;
315 push(@export_file_list, $file);
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200316 } elsif ($cmd eq "v") {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 $verbose = 1;
Pierre-Louis Bossart2c12c812020-07-28 11:20:40 -0500318 } elsif ($cmd eq "Werror") {
319 $Werror = 1;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200320 } elsif (($cmd eq "h") || ($cmd eq "help")) {
Tomasz Warniełło252b47d2022-02-18 19:16:26 +0100321 pod2usage(-exitval => 0, -verbose => 2);
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200322 } elsif ($cmd eq 'no-doc-sections') {
Johannes Berg4b445952007-10-24 15:08:48 -0700323 $no_doc_sections = 1;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200324 } elsif ($cmd eq 'enable-lineno') {
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200325 $enable_lineno = 1;
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200326 } elsif ($cmd eq 'show-not-found') {
Jonathan Corbetb0d60bf2019-05-24 14:52:01 -0600327 $show_not_found = 1; # A no-op but don't fail
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +0200328 } elsif ($cmd eq "sphinx-version") {
329 my $ver_string = shift @ARGV;
330 if ($ver_string =~ m/^(\d+)(\.\d+)?(\.\d+)?/) {
331 $sphinx_major = $1;
332 if (defined($2)) {
333 $sphinx_minor = substr($2,1);
334 } else {
335 $sphinx_minor = 0;
336 }
337 if (defined($3)) {
338 $sphinx_patch = substr($3,1)
339 } else {
340 $sphinx_patch = 0;
341 }
342 } else {
343 die "Sphinx version should either major.minor or major.minor.patch format\n";
344 }
Mauro Carvalho Chehabb031ac42017-12-18 10:30:10 -0200345 } else {
Akira Yokosawae334f872022-02-24 22:02:46 +0900346 # Unknown argument
347 pod2usage(
348 -message => "Argument unknown!\n",
349 -exitval => 1,
350 -verbose => 99,
351 -sections => 'SYNOPSIS',
352 -output => \*STDERR,
353 );
354 }
355 if ($#ARGV < 0){
356 pod2usage(
357 -message => "FILE argument missing\n",
358 -exitval => 1,
359 -verbose => 99,
360 -sections => 'SYNOPSIS',
361 -output => \*STDERR,
362 );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 }
364}
365
Randy Dunlap8484baa2011-01-05 16:28:43 -0800366# continue execution near EOF;
367
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200368# The C domain dialect changed on Sphinx 3. So, we need to check the
369# version in order to produce the right tags.
370sub findprog($)
371{
372 foreach(split(/:/, $ENV{PATH})) {
373 return "$_/$_[0]" if(-x "$_/$_[0]");
374 }
375}
376
377sub get_sphinx_version()
378{
379 my $ver;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200380
381 my $cmd = "sphinx-build";
382 if (!findprog($cmd)) {
383 my $cmd = "sphinx-build3";
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +0200384 if (!findprog($cmd)) {
385 $sphinx_major = 1;
386 $sphinx_minor = 2;
387 $sphinx_patch = 0;
388 printf STDERR "Warning: Sphinx version not found. Using default (Sphinx version %d.%d.%d)\n",
389 $sphinx_major, $sphinx_minor, $sphinx_patch;
390 return;
391 }
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200392 }
393
394 open IN, "$cmd --version 2>&1 |";
395 while (<IN>) {
396 if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) {
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +0200397 $sphinx_major = $1;
398 $sphinx_minor = $2;
399 $sphinx_patch = $3;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200400 last;
401 }
402 # Sphinx 1.2.x uses a different format
403 if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) {
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +0200404 $sphinx_major = $1;
405 $sphinx_minor = $2;
406 $sphinx_patch = $3;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200407 last;
408 }
409 }
410 close IN;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200411}
412
Borislav Petkov53f049f2007-05-08 00:30:54 -0700413# get kernel version from env
414sub get_kernel_version() {
Johannes Berg1b9bc222007-10-24 15:08:48 -0700415 my $version = 'unknown kernel version';
Borislav Petkov53f049f2007-05-08 00:30:54 -0700416
417 if (defined($ENV{'KERNELVERSION'})) {
418 $version = $ENV{'KERNELVERSION'};
419 }
420 return $version;
421}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200423#
424sub print_lineno {
425 my $lineno = shift;
426 if ($enable_lineno && defined($lineno)) {
Mauro Carvalho Chehabb79dfef2022-03-26 11:27:24 +0100427 print ".. LINENO " . $lineno . "\n";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200428 }
429}
Niklas Söderlunddf4bf982022-06-13 11:05:10 +0200430
431sub emit_warning {
432 my $location = shift;
433 my $msg = shift;
434 print STDERR "$location: warning: $msg";
435 ++$warnings;
436}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437##
438# dumps section contents to arrays/hashes intended for that purpose.
439#
440sub dump_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700441 my $file = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 my $name = shift;
443 my $contents = join "\n", @_;
444
Jani Nikula13901ef2016-05-26 08:57:29 +0300445 if ($name =~ m/$type_param/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 $name = $1;
447 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800448 $sectcheck = $sectcheck . $name . " ";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200449 $parameterdesc_start_lines{$name} = $new_start_line;
450 $new_start_line = 0;
Randy Dunlapced69092008-12-01 13:14:03 -0800451 } elsif ($name eq "@\.\.\.") {
Randy Dunlapced69092008-12-01 13:14:03 -0800452 $name = "...";
453 $parameterdescs{$name} = $contents;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -0800454 $sectcheck = $sectcheck . $name . " ";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200455 $parameterdesc_start_lines{$name} = $new_start_line;
456 $new_start_line = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 } else {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700458 if (defined($sections{$name}) && ($sections{$name} ne "")) {
Jani Nikula95b6be92016-06-10 11:14:05 +0300459 # Only warn on user specified duplicate section names.
460 if ($name ne $section_default) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +0200461 emit_warning("${file}:$.", "duplicate section name '$name'\n");
Jani Nikula95b6be92016-06-10 11:14:05 +0300462 }
Jani Nikula32217762016-05-29 09:40:44 +0300463 $sections{$name} .= $contents;
464 } else {
465 $sections{$name} = $contents;
466 push @sectionlist, $name;
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200467 $section_start_lines{$name} = $new_start_line;
468 $new_start_line = 0;
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 }
471}
472
473##
Johannes Bergb112e0f2007-10-24 15:08:48 -0700474# dump DOC: section after checking that it should go out
475#
476sub dump_doc_section {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700477 my $file = shift;
Johannes Bergb112e0f2007-10-24 15:08:48 -0700478 my $name = shift;
479 my $contents = join "\n", @_;
480
Johannes Berg4b445952007-10-24 15:08:48 -0700481 if ($no_doc_sections) {
482 return;
483 }
484
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200485 return if (defined($nosymbol_table{$name}));
486
Jani Nikulab6c3f452016-05-29 22:19:35 +0300487 if (($output_selection == OUTPUT_ALL) ||
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200488 (($output_selection == OUTPUT_INCLUDE) &&
489 defined($function_table{$name})))
Johannes Bergb112e0f2007-10-24 15:08:48 -0700490 {
Randy Dunlap94dc7ad2008-04-28 02:16:34 -0700491 dump_section($file, $name, $contents);
Johannes Bergb112e0f2007-10-24 15:08:48 -0700492 output_blockhead({'sectionlist' => \@sectionlist,
493 'sections' => \%sections,
494 'module' => $modulename,
Jani Nikulab6c3f452016-05-29 22:19:35 +0300495 'content-only' => ($output_selection != OUTPUT_ALL), });
Johannes Bergb112e0f2007-10-24 15:08:48 -0700496 }
497}
498
499##
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500# output function
501#
502# parameterdescs, a hash.
503# function => "function name"
504# parameterlist => @list of parameters
505# parameterdescs => %parameter descriptions
506# sectionlist => @list of sections
Randy Dunlapa21217d2007-02-10 01:46:04 -0800507# sections => %section descriptions
Randy Dunlap3c3b8092006-02-01 03:06:58 -0800508#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510sub output_highlight {
511 my $contents = join "\n",@_;
512 my $line;
513
514# DEBUG
515# if (!defined $contents) {
516# use Carp;
517# confess "output_highlight got called with no args?\n";
518# }
519
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700520# print STDERR "contents b4:$contents\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 eval $dohighlight;
522 die $@ if $@;
Randy Dunlap3eb014a2007-05-08 00:29:51 -0700523# print STDERR "contents af:$contents\n";
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 foreach $line (split "\n", $contents) {
Daniel Santos12ae6772012-10-04 17:15:10 -0700526 if (! $output_preformatted) {
527 $line =~ s/^\s*//;
528 }
Randy Dunlap3c308792007-05-08 00:24:39 -0700529 if ($line eq ""){
Daniel Santose314ba32012-10-04 17:15:08 -0700530 if (! $output_preformatted) {
Jonathan Corbet0bba9242018-02-05 12:40:15 -0700531 print $lineprefix, $blankline;
Daniel Santose314ba32012-10-04 17:15:08 -0700532 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 } else {
Randy Dunlapcdccb312007-07-19 01:48:25 -0700534 if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
535 print "\\&$line";
536 } else {
537 print $lineprefix, $line;
538 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 }
540 print "\n";
541 }
542}
543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544##
545# output function in man
546sub output_function_man(%) {
547 my %args = %{$_[0]};
548 my ($parameter, $section);
549 my $count;
550
551 print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\" \"Kernel Hacker's Manual\" LINUX\n";
552
553 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700554 print $args{'function'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
556 print ".SH SYNOPSIS\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -0800557 if ($args{'functiontype'} ne "") {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700558 print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -0800559 } else {
Randy Dunlapb9d973282009-06-09 08:50:38 -0700560 print ".B \"" . $args{'function'} . "\n";
Randy Dunlapa21217d2007-02-10 01:46:04 -0800561 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 $count = 0;
563 my $parenth = "(";
564 my $post = ",";
565 foreach my $parameter (@{$args{'parameterlist'}}) {
566 if ($count == $#{$args{'parameterlist'}}) {
567 $post = ");";
568 }
569 $type = $args{'parametertypes'}{$parameter};
Aditya Srivastavae86bdb22021-05-14 20:12:44 +0530570 if ($type =~ m/$function_pointer/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 # pointer-to-function
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +0200572 print ".BI \"" . $parenth . $1 . "\" " . " \") (" . $2 . ")" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 } else {
574 $type =~ s/([^\*])$/$1 /;
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +0200575 print ".BI \"" . $parenth . $type . "\" " . " \"" . $post . "\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 }
577 $count++;
578 $parenth = "";
579 }
580
581 print ".SH ARGUMENTS\n";
582 foreach $parameter (@{$args{'parameterlist'}}) {
583 my $parameter_name = $parameter;
584 $parameter_name =~ s/\[.*//;
585
Randy Dunlapb9d973282009-06-09 08:50:38 -0700586 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 output_highlight($args{'parameterdescs'}{$parameter_name});
588 }
589 foreach $section (@{$args{'sectionlist'}}) {
590 print ".SH \"", uc $section, "\"\n";
591 output_highlight($args{'sections'}{$section});
592 }
593}
594
595##
596# output enum in man
597sub output_enum_man(%) {
598 my %args = %{$_[0]};
599 my ($parameter, $section);
600 my $count;
601
602 print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" \"API Manual\" LINUX\n";
603
604 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700605 print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700608 print "enum " . $args{'enum'} . " {\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 $count = 0;
610 foreach my $parameter (@{$args{'parameterlist'}}) {
Randy Dunlap3c308792007-05-08 00:24:39 -0700611 print ".br\n.BI \" $parameter\"\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 if ($count == $#{$args{'parameterlist'}}) {
613 print "\n};\n";
614 last;
615 }
616 else {
617 print ", \n.br\n";
618 }
619 $count++;
620 }
621
622 print ".SH Constants\n";
623 foreach $parameter (@{$args{'parameterlist'}}) {
624 my $parameter_name = $parameter;
625 $parameter_name =~ s/\[.*//;
626
Randy Dunlapb9d973282009-06-09 08:50:38 -0700627 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 output_highlight($args{'parameterdescs'}{$parameter_name});
629 }
630 foreach $section (@{$args{'sectionlist'}}) {
631 print ".SH \"$section\"\n";
632 output_highlight($args{'sections'}{$section});
633 }
634}
635
636##
637# output struct in man
638sub output_struct_man(%) {
639 my %args = %{$_[0]};
640 my ($parameter, $section);
641
Randy Dunlapb9d973282009-06-09 08:50:38 -0700642 print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'struct'} . "\" \"$man_date\" \"API Manual\" LINUX\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
644 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700645 print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -0200647 my $declaration = $args{'definition'};
648 $declaration =~ s/\t/ /g;
649 $declaration =~ s/\n/"\n.br\n.BI \"/g;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 print ".SH SYNOPSIS\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700651 print $args{'type'} . " " . $args{'struct'} . " {\n.br\n";
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -0200652 print ".BI \"$declaration\n};\n.br\n\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Randy Dunlapc51d3dac2006-06-25 05:49:14 -0700654 print ".SH Members\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 foreach $parameter (@{$args{'parameterlist'}}) {
656 ($parameter =~ /^#/) && next;
657
658 my $parameter_name = $parameter;
659 $parameter_name =~ s/\[.*//;
660
Randy Dunlap3c308792007-05-08 00:24:39 -0700661 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
Randy Dunlapb9d973282009-06-09 08:50:38 -0700662 print ".IP \"" . $parameter . "\" 12\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 output_highlight($args{'parameterdescs'}{$parameter_name});
664 }
665 foreach $section (@{$args{'sectionlist'}}) {
666 print ".SH \"$section\"\n";
667 output_highlight($args{'sections'}{$section});
668 }
669}
670
671##
672# output typedef in man
673sub output_typedef_man(%) {
674 my %args = %{$_[0]};
675 my ($parameter, $section);
676
677 print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"API Manual\" LINUX\n";
678
679 print ".SH NAME\n";
Randy Dunlapb9d973282009-06-09 08:50:38 -0700680 print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
682 foreach $section (@{$args{'sectionlist'}}) {
683 print ".SH \"$section\"\n";
684 output_highlight($args{'sections'}{$section});
685 }
686}
687
Johannes Bergb112e0f2007-10-24 15:08:48 -0700688sub output_blockhead_man(%) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 my %args = %{$_[0]};
690 my ($parameter, $section);
691 my $count;
692
693 print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"API Manual\" LINUX\n";
694
695 foreach $section (@{$args{'sectionlist'}}) {
696 print ".SH \"$section\"\n";
697 output_highlight($args{'sections'}{$section});
698 }
699}
700
701##
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300702# output in restructured text
703#
704
705#
706# This could use some work; it's used to output the DOC: sections, and
707# starts by putting out the name of the doc section itself, but that tends
708# to duplicate a header already in the template file.
709#
710sub output_blockhead_rst(%) {
711 my %args = %{$_[0]};
712 my ($parameter, $section);
713
714 foreach $section (@{$args{'sectionlist'}}) {
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +0200715 next if (defined($nosymbol_table{$section}));
716
Jani Nikula9e721842016-05-29 22:27:35 +0300717 if ($output_selection != OUTPUT_INCLUDE) {
Michal Wajdeczko06a755d2021-01-18 12:08:13 +0100718 print ".. _$section:\n\n";
Jani Nikula9e721842016-05-29 22:27:35 +0300719 print "**$section**\n\n";
720 }
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200721 print_lineno($section_start_lines{$section});
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300722 output_highlight_rst($args{'sections'}{$section});
723 print "\n";
724 }
725}
726
Jonathan Corbetaf250292018-02-06 15:58:45 -0700727#
728# Apply the RST highlights to a sub-block of text.
Mike Rapoport76dd3e72018-11-07 18:47:12 +0200729#
Jonathan Corbetaf250292018-02-06 15:58:45 -0700730sub highlight_block($) {
731 # The dohighlight kludge requires the text be called $contents
732 my $contents = shift;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300733 eval $dohighlight;
734 die $@ if $@;
Jonathan Corbetaf250292018-02-06 15:58:45 -0700735 return $contents;
736}
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300737
Jonathan Corbetaf250292018-02-06 15:58:45 -0700738#
739# Regexes used only here.
740#
741my $sphinx_literal = '^[^.].*::$';
742my $sphinx_cblock = '^\.\.\ +code-block::';
743
744sub output_highlight_rst {
745 my $input = join "\n",@_;
746 my $output = "";
747 my $line;
748 my $in_literal = 0;
749 my $litprefix;
750 my $block = "";
751
752 foreach $line (split "\n",$input) {
753 #
754 # If we're in a literal block, see if we should drop out
755 # of it. Otherwise pass the line straight through unmunged.
756 #
757 if ($in_literal) {
758 if (! ($line =~ /^\s*$/)) {
759 #
760 # If this is the first non-blank line in a literal
761 # block we need to figure out what the proper indent is.
762 #
763 if ($litprefix eq "") {
764 $line =~ /^(\s*)/;
765 $litprefix = '^' . $1;
766 $output .= $line . "\n";
767 } elsif (! ($line =~ /$litprefix/)) {
768 $in_literal = 0;
769 } else {
770 $output .= $line . "\n";
771 }
772 } else {
773 $output .= $line . "\n";
774 }
775 }
776 #
777 # Not in a literal block (or just dropped out)
778 #
779 if (! $in_literal) {
780 $block .= $line . "\n";
781 if (($line =~ /$sphinx_literal/) || ($line =~ /$sphinx_cblock/)) {
782 $in_literal = 1;
783 $litprefix = "";
784 $output .= highlight_block($block);
785 $block = ""
786 }
787 }
788 }
789
790 if ($block) {
791 $output .= highlight_block($block);
792 }
793 foreach $line (split "\n", $output) {
Jani Nikula830066a2016-05-26 22:04:33 +0300794 print $lineprefix . $line . "\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300795 }
796}
797
798sub output_function_rst(%) {
799 my %args = %{$_[0]};
800 my ($parameter, $section);
Jani Nikulac099ff62016-05-26 17:18:17 +0300801 my $oldprefix = $lineprefix;
Mauro Carvalho Chehab82801d02016-08-30 20:20:58 -0300802 my $start = "";
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200803 my $is_macro = 0;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300804
Mauro Carvalho Chehabe3ad05f2020-09-25 10:05:40 +0200805 if ($sphinx_major < 3) {
806 if ($args{'typedef'}) {
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200807 print ".. c:type:: ". $args{'function'} . "\n\n";
Mauro Carvalho Chehabe3ad05f2020-09-25 10:05:40 +0200808 print_lineno($declaration_start_line);
809 print " **Typedef**: ";
810 $lineprefix = "";
811 output_highlight_rst($args{'purpose'});
812 $start = "\n\n**Syntax**\n\n ``";
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200813 $is_macro = 1;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200814 } else {
Mauro Carvalho Chehabe3ad05f2020-09-25 10:05:40 +0200815 print ".. c:function:: ";
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200816 }
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300817 } else {
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200818 if ($args{'typedef'} || $args{'functiontype'} eq "") {
819 $is_macro = 1;
820 print ".. c:macro:: ". $args{'function'} . "\n\n";
821 } else {
822 print ".. c:function:: ";
823 }
Mauro Carvalho Chehabe3ad05f2020-09-25 10:05:40 +0200824
825 if ($args{'typedef'}) {
826 print_lineno($declaration_start_line);
827 print " **Typedef**: ";
828 $lineprefix = "";
829 output_highlight_rst($args{'purpose'});
830 $start = "\n\n**Syntax**\n\n ``";
831 } else {
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200832 print "``" if ($is_macro);
Mauro Carvalho Chehabe3ad05f2020-09-25 10:05:40 +0200833 }
Mauro Carvalho Chehab82801d02016-08-30 20:20:58 -0300834 }
835 if ($args{'functiontype'} ne "") {
836 $start .= $args{'functiontype'} . " " . $args{'function'} . " (";
837 } else {
838 $start .= $args{'function'} . " (";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300839 }
840 print $start;
841
842 my $count = 0;
843 foreach my $parameter (@{$args{'parameterlist'}}) {
844 if ($count ne 0) {
845 print ", ";
846 }
847 $count++;
848 $type = $args{'parametertypes'}{$parameter};
Mauro Carvalho Chehaba88b1672016-07-22 11:46:36 -0300849
Aditya Srivastavae86bdb22021-05-14 20:12:44 +0530850 if ($type =~ m/$function_pointer/) {
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300851 # pointer-to-function
Peter Maydelle8f4ba82020-04-14 15:37:43 +0100852 print $1 . $parameter . ") (" . $2 . ")";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300853 } else {
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +0200854 print $type;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300855 }
856 }
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200857 if ($is_macro) {
858 print ")``\n\n";
Mauro Carvalho Chehab82801d02016-08-30 20:20:58 -0300859 } else {
Mauro Carvalho Chehab6e9e4152020-09-30 09:47:01 +0200860 print ")\n\n";
861 }
862 if (!$args{'typedef'}) {
Mauro Carvalho Chehab82801d02016-08-30 20:20:58 -0300863 print_lineno($declaration_start_line);
864 $lineprefix = " ";
865 output_highlight_rst($args{'purpose'});
866 print "\n";
867 }
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300868
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300869 print "**Parameters**\n\n";
870 $lineprefix = " ";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300871 foreach $parameter (@{$args{'parameterlist'}}) {
872 my $parameter_name = $parameter;
Gabriel Krisman Bertaziada5f442017-01-09 18:11:57 -0200873 $parameter_name =~ s/\[.*//;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300874 $type = $args{'parametertypes'}{$parameter};
875
876 if ($type ne "") {
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +0200877 print "``$type``\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300878 } else {
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300879 print "``$parameter``\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300880 }
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200881
882 print_lineno($parameterdesc_start_lines{$parameter_name});
883
Jani Nikula5e64fa92016-05-19 20:32:48 +0300884 if (defined($args{'parameterdescs'}{$parameter_name}) &&
885 $args{'parameterdescs'}{$parameter_name} ne $undescribed) {
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300886 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300887 } else {
Jani Nikulad4b08e02016-05-28 00:48:17 +0300888 print " *undescribed*\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300889 }
890 print "\n";
891 }
Jani Nikulac099ff62016-05-26 17:18:17 +0300892
893 $lineprefix = $oldprefix;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300894 output_section_rst(@_);
895}
896
897sub output_section_rst(%) {
898 my %args = %{$_[0]};
899 my $section;
900 my $oldprefix = $lineprefix;
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300901 $lineprefix = "";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300902
903 foreach $section (@{$args{'sectionlist'}}) {
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300904 print "**$section**\n\n";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200905 print_lineno($section_start_lines{$section});
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300906 output_highlight_rst($args{'sections'}{$section});
907 print "\n";
908 }
909 print "\n";
910 $lineprefix = $oldprefix;
911}
912
913sub output_enum_rst(%) {
914 my %args = %{$_[0]};
915 my ($parameter);
Jani Nikulac099ff62016-05-26 17:18:17 +0300916 my $oldprefix = $lineprefix;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300917 my $count;
Jani Nikula62850972016-05-12 16:15:38 +0300918
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200919 if ($sphinx_major < 3) {
920 my $name = "enum " . $args{'enum'};
921 print "\n\n.. c:type:: " . $name . "\n\n";
922 } else {
923 my $name = $args{'enum'};
924 print "\n\n.. c:enum:: " . $name . "\n\n";
925 }
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200926 print_lineno($declaration_start_line);
Jani Nikulac099ff62016-05-26 17:18:17 +0300927 $lineprefix = " ";
928 output_highlight_rst($args{'purpose'});
929 print "\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300930
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300931 print "**Constants**\n\n";
932 $lineprefix = " ";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300933 foreach $parameter (@{$args{'parameterlist'}}) {
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300934 print "``$parameter``\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300935 if ($args{'parameterdescs'}{$parameter} ne $undescribed) {
936 output_highlight_rst($args{'parameterdescs'}{$parameter});
937 } else {
Jani Nikulad4b08e02016-05-28 00:48:17 +0300938 print " *undescribed*\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300939 }
940 print "\n";
941 }
Jani Nikulac099ff62016-05-26 17:18:17 +0300942
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300943 $lineprefix = $oldprefix;
944 output_section_rst(@_);
945}
946
947sub output_typedef_rst(%) {
948 my %args = %{$_[0]};
949 my ($parameter);
Jani Nikulac099ff62016-05-26 17:18:17 +0300950 my $oldprefix = $lineprefix;
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200951 my $name;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300952
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200953 if ($sphinx_major < 3) {
954 $name = "typedef " . $args{'typedef'};
955 } else {
956 $name = $args{'typedef'};
957 }
Jani Nikula62850972016-05-12 16:15:38 +0300958 print "\n\n.. c:type:: " . $name . "\n\n";
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200959 print_lineno($declaration_start_line);
Jani Nikulac099ff62016-05-26 17:18:17 +0300960 $lineprefix = " ";
961 output_highlight_rst($args{'purpose'});
962 print "\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300963
Jani Nikulac099ff62016-05-26 17:18:17 +0300964 $lineprefix = $oldprefix;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300965 output_section_rst(@_);
966}
967
968sub output_struct_rst(%) {
969 my %args = %{$_[0]};
970 my ($parameter);
Jani Nikulac099ff62016-05-26 17:18:17 +0300971 my $oldprefix = $lineprefix;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300972
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200973 if ($sphinx_major < 3) {
974 my $name = $args{'type'} . " " . $args{'struct'};
975 print "\n\n.. c:type:: " . $name . "\n\n";
976 } else {
977 my $name = $args{'struct'};
Mauro Carvalho Chehab72b97d02020-10-27 10:51:05 +0100978 if ($args{'type'} eq 'union') {
979 print "\n\n.. c:union:: " . $name . "\n\n";
980 } else {
981 print "\n\n.. c:struct:: " . $name . "\n\n";
982 }
Mauro Carvalho Chehabefa444752020-09-24 15:30:37 +0200983 }
Daniel Vetter0b0f5f292016-06-03 22:21:34 +0200984 print_lineno($declaration_start_line);
Jani Nikulac099ff62016-05-26 17:18:17 +0300985 $lineprefix = " ";
986 output_highlight_rst($args{'purpose'});
987 print "\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300988
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300989 print "**Definition**\n\n";
990 print "::\n\n";
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -0200991 my $declaration = $args{'definition'};
992 $declaration =~ s/\t/ /g;
993 print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration };\n\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300994
Jani Nikulaecbcfba2016-05-26 18:30:27 +0300995 print "**Members**\n\n";
996 $lineprefix = " ";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +0300997 foreach $parameter (@{$args{'parameterlist'}}) {
998 ($parameter =~ /^#/) && next;
999
1000 my $parameter_name = $parameter;
1001 $parameter_name =~ s/\[.*//;
1002
1003 ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
1004 $type = $args{'parametertypes'}{$parameter};
Daniel Vetter0b0f5f292016-06-03 22:21:34 +02001005 print_lineno($parameterdesc_start_lines{$parameter_name});
Mauro Carvalho Chehab6d232c82016-08-22 22:02:57 -03001006 print "``" . $parameter . "``\n";
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +03001007 output_highlight_rst($args{'parameterdescs'}{$parameter_name});
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +03001008 print "\n";
1009 }
1010 print "\n";
Jani Nikulac099ff62016-05-26 17:18:17 +03001011
1012 $lineprefix = $oldprefix;
Jonathan Corbetc0d1b6e2016-05-12 16:15:37 +03001013 output_section_rst(@_);
1014}
1015
Matthew Wilcox3a025e12017-11-20 10:40:40 -08001016## none mode output functions
1017
1018sub output_function_none(%) {
1019}
1020
1021sub output_enum_none(%) {
1022}
1023
1024sub output_typedef_none(%) {
1025}
1026
1027sub output_struct_none(%) {
1028}
1029
1030sub output_blockhead_none(%) {
1031}
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033##
Randy Dunlap27205742006-10-11 01:22:12 -07001034# generic output function for all types (function, struct/union, typedef, enum);
1035# calls the generated, variable output_ function name based on
1036# functype and output_mode
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037sub output_declaration {
1038 no strict 'refs';
1039 my $name = shift;
1040 my $functype = shift;
1041 my $func = "output_${functype}_$output_mode";
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +02001042
1043 return if (defined($nosymbol_table{$name}));
1044
Jani Nikulab6c3f452016-05-29 22:19:35 +03001045 if (($output_selection == OUTPUT_ALL) ||
1046 (($output_selection == OUTPUT_INCLUDE ||
1047 $output_selection == OUTPUT_EXPORTED) &&
1048 defined($function_table{$name})) ||
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +02001049 ($output_selection == OUTPUT_INTERNAL &&
Jani Nikulab6c3f452016-05-29 22:19:35 +03001050 !($functype eq "function" && defined($function_table{$name}))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 {
Randy Dunlap3c308792007-05-08 00:24:39 -07001052 &$func(@_);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 $section_counter++;
1054 }
1055}
1056
1057##
Randy Dunlap27205742006-10-11 01:22:12 -07001058# generic output function - calls the right one based on current output mode.
Johannes Bergb112e0f2007-10-24 15:08:48 -07001059sub output_blockhead {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 no strict 'refs';
Randy Dunlapb9d973282009-06-09 08:50:38 -07001061 my $func = "output_blockhead_" . $output_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 &$func(@_);
1063 $section_counter++;
1064}
1065
1066##
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001067# takes a declaration (struct, union, enum, typedef) and
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068# invokes the right handler. NOT called for functions.
1069sub dump_declaration($$) {
1070 no strict 'refs';
1071 my ($prototype, $file) = @_;
Randy Dunlapb9d973282009-06-09 08:50:38 -07001072 my $func = "dump_" . $decl_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 &$func(@_);
1074}
1075
1076sub dump_union($$) {
1077 dump_struct(@_);
1078}
1079
1080sub dump_struct($$) {
1081 my $x = shift;
1082 my $file = shift;
Aditya Srivastavaa746fe32021-02-25 20:20:33 +05301083 my $decl_type;
1084 my $members;
1085 my $type = qr{struct|union};
1086 # For capturing struct/union definition body, i.e. "{members*}qualifiers*"
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301087 my $qualifiers = qr{$attribute|__packed|__aligned|____cacheline_aligned_in_smp|____cacheline_aligned};
1088 my $definition_body = qr{\{(.*)\}\s*$qualifiers*};
1089 my $struct_members = qr{($type)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Aditya Srivastavaa746fe32021-02-25 20:20:33 +05301091 if ($x =~ /($type)\s+(\w+)\s*$definition_body/) {
1092 $decl_type = $1;
Randy Dunlap3c308792007-05-08 00:24:39 -07001093 $declaration_name = $2;
Aditya Srivastavaa746fe32021-02-25 20:20:33 +05301094 $members = $3;
1095 } elsif ($x =~ /typedef\s+($type)\s*$definition_body\s*(\w+)\s*;/) {
1096 $decl_type = $1;
1097 $declaration_name = $3;
1098 $members = $2;
1099 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100
Aditya Srivastavaa746fe32021-02-25 20:20:33 +05301101 if ($members) {
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001102 if ($identifier ne $declaration_name) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001103 emit_warning("${file}:$.", "expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001104 return;
1105 }
1106
Martin Waitzaeec46b2005-11-13 16:08:13 -08001107 # ignore members marked private:
Mauro Carvalho Chehab0d8c39e2015-10-05 09:03:48 -03001108 $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
1109 $members =~ s/\/\*\s*private:.*//gosi;
Martin Waitzaeec46b2005-11-13 16:08:13 -08001110 # strip comments:
1111 $members =~ s/\/\*.*?\*\///gos;
Randy Dunlapef5da592010-03-23 13:35:14 -07001112 # strip attributes
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301113 $members =~ s/\s*$attribute/ /gi;
André Almeida2b5f78e2019-09-17 16:41:45 -03001114 $members =~ s/\s*__aligned\s*\([^;]*\)/ /gos;
1115 $members =~ s/\s*__packed\s*/ /gos;
1116 $members =~ s/\s*CRYPTO_MINALIGN_ATTR/ /gos;
André Almeidaf8615372019-09-17 16:41:46 -03001117 $members =~ s/\s*____cacheline_aligned_in_smp/ /gos;
Jonathan Camerona0709912020-09-10 19:54:15 +01001118 $members =~ s/\s*____cacheline_aligned/ /gos;
Kees Cook50d7bd32021-05-17 20:01:15 -07001119 # unwrap struct_group():
1120 # - first eat non-declaration parameters and rewrite for final match
1121 # - then remove macro, outer parens, and trailing semicolon
1122 $members =~ s/\bstruct_group\s*\(([^,]*,)/STRUCT_GROUP(/gos;
1123 $members =~ s/\bstruct_group_(attr|tagged)\s*\(([^,]*,){2}/STRUCT_GROUP(/gos;
1124 $members =~ s/\b__struct_group\s*\(([^,]*,){3}/STRUCT_GROUP(/gos;
1125 $members =~ s/\bSTRUCT_GROUP(\(((?:(?>[^)(]+)|(?1))*)\))[^;]*;/$2/gos;
Mauro Carvalho Chehab35561082020-06-23 09:09:00 +02001126
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301127 my $args = qr{([^,)]+)};
Conchúr Navidb22b5a92015-11-08 10:52:00 +01001128 # replace DECLARE_BITMAP
Mauro Carvalho Chehab35561082020-06-23 09:09:00 +02001129 $members =~ s/__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, __ETHTOOL_LINK_MODE_MASK_NBITS)/gos;
Randy Dunlap603bdf52021-10-29 19:11:21 -07001130 $members =~ s/DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)/DECLARE_BITMAP($1, PHY_INTERFACE_MODE_MAX)/gos;
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301131 $members =~ s/DECLARE_BITMAP\s*\($args,\s*$args\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;
Jakub Kicinski1cb566b2017-06-30 19:09:59 -07001132 # replace DECLARE_HASHTABLE
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301133 $members =~ s/DECLARE_HASHTABLE\s*\($args,\s*$args\)/unsigned long $1\[1 << (($2) - 1)\]/gos;
Mauro Carvalho Chehab45005b22017-12-08 09:05:12 -05001134 # replace DECLARE_KFIFO
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301135 $members =~ s/DECLARE_KFIFO\s*\($args,\s*$args,\s*$args\)/$2 \*$1/gos;
Mauro Carvalho Chehab45005b22017-12-08 09:05:12 -05001136 # replace DECLARE_KFIFO_PTR
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301137 $members =~ s/DECLARE_KFIFO_PTR\s*\($args,\s*$args\)/$2 \*$1/gos;
Kees Cook3080ea52021-08-09 11:21:23 -07001138 # replace DECLARE_FLEX_ARRAY
1139 $members =~ s/(?:__)?DECLARE_FLEX_ARRAY\s*\($args,\s*$args\)/$1 $2\[\]/gos;
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001140 my $declaration = $members;
1141
1142 # Split nested struct/union elements as newer ones
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301143 while ($members =~ m/$struct_members/) {
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001144 my $newmember;
1145 my $maintype = $1;
1146 my $ids = $4;
1147 my $content = $3;
1148 foreach my $id(split /,/, $ids) {
1149 $newmember .= "$maintype $id; ";
1150
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001151 $id =~ s/[:\[].*//;
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001152 $id =~ s/^\s*\**(\S+)\s*/$1/;
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001153 foreach my $arg (split /;/, $content) {
1154 next if ($arg =~ m/^\s*$/);
Mauro Carvalho Chehab7c0d7e82017-12-18 10:30:16 -02001155 if ($arg =~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) {
1156 # pointer-to-function
1157 my $type = $1;
1158 my $name = $2;
1159 my $extra = $3;
1160 next if (!$name);
1161 if ($id =~ m/^\s*$/) {
1162 # anonymous struct/union
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001163 $newmember .= "$type$name$extra; ";
Mauro Carvalho Chehab7c0d7e82017-12-18 10:30:16 -02001164 } else {
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001165 $newmember .= "$type$id.$name$extra; ";
Mauro Carvalho Chehab7c0d7e82017-12-18 10:30:16 -02001166 }
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001167 } else {
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001168 my $type;
1169 my $names;
1170 $arg =~ s/^\s+//;
1171 $arg =~ s/\s+$//;
1172 # Handle bitmaps
1173 $arg =~ s/:\s*\d+\s*//g;
1174 # Handle arrays
Mauro Carvalho Chehabd404d572018-03-29 10:58:59 -04001175 $arg =~ s/\[.*\]//g;
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001176 # The type may have multiple words,
1177 # and multiple IDs can be defined, like:
1178 # const struct foo, *bar, foobar
1179 # So, we remove spaces when parsing the
1180 # names, in order to match just names
1181 # and commas for the names
1182 $arg =~ s/\s*,\s*/,/g;
1183 if ($arg =~ m/(.*)\s+([\S+,]+)/) {
1184 $type = $1;
1185 $names = $2;
Mauro Carvalho Chehab7c0d7e82017-12-18 10:30:16 -02001186 } else {
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001187 $newmember .= "$arg; ";
1188 next;
1189 }
1190 foreach my $name (split /,/, $names) {
1191 $name =~ s/^\s*\**(\S+)\s*/$1/;
1192 next if (($name =~ m/^\s*$/));
1193 if ($id =~ m/^\s*$/) {
1194 # anonymous struct/union
1195 $newmember .= "$type $name; ";
1196 } else {
1197 $newmember .= "$type $id.$name; ";
1198 }
Mauro Carvalho Chehab7c0d7e82017-12-18 10:30:16 -02001199 }
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001200 }
1201 }
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001202 }
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301203 $members =~ s/$struct_members/$newmember/;
Mauro Carvalho Chehab84ce5b92017-12-18 10:30:17 -02001204 }
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001205
1206 # Ignore other nested elements, like enums
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001207 $members =~ s/(\{[^\{\}]*\})//g;
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001208
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001209 create_parameterlist($members, ';', $file, $declaration_name);
Mauro Carvalho Chehab1081de22017-12-18 10:30:14 -02001210 check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_actual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001212 # Adjust declaration for better display
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001213 $declaration =~ s/([\{;])/$1\n/g;
1214 $declaration =~ s/\}\s+;/};/g;
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001215 # Better handle inlined enums
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001216 do {} while ($declaration =~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/);
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001217
1218 my @def_args = split /\n/, $declaration;
1219 my $level = 1;
1220 $declaration = "";
1221 foreach my $clause (@def_args) {
1222 $clause =~ s/^\s+//;
1223 $clause =~ s/\s+$//;
1224 $clause =~ s/\s+/ /;
1225 next if (!$clause);
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001226 $level-- if ($clause =~ m/(\})/ && $level > 1);
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001227 if (!($clause =~ m/^\s*#/)) {
1228 $declaration .= "\t" x $level;
1229 }
1230 $declaration .= "\t" . $clause . "\n";
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001231 $level++ if ($clause =~ m/(\{)/ && !($clause =~m/\}/));
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001232 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 output_declaration($declaration_name,
1234 'struct',
1235 {'struct' => $declaration_name,
1236 'module' => $modulename,
Mauro Carvalho Chehab8ad72162017-12-18 10:30:13 -02001237 'definition' => $declaration,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 'parameterlist' => \@parameterlist,
1239 'parameterdescs' => \%parameterdescs,
1240 'parametertypes' => \%parametertypes,
1241 'sectionlist' => \@sectionlist,
1242 'sections' => \%sections,
1243 'purpose' => $declaration_purpose,
1244 'type' => $decl_type
1245 });
1246 }
1247 else {
Bart Van Assched40e1e62015-09-04 15:43:21 -07001248 print STDERR "${file}:$.: error: Cannot parse struct or union!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 ++$errors;
1250 }
1251}
1252
Mauro Carvalho Chehab85afe602017-12-30 22:32:55 -02001253
1254sub show_warnings($$) {
1255 my $functype = shift;
1256 my $name = shift;
1257
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +02001258 return 0 if (defined($nosymbol_table{$name}));
1259
Mauro Carvalho Chehab85afe602017-12-30 22:32:55 -02001260 return 1 if ($output_selection == OUTPUT_ALL);
1261
1262 if ($output_selection == OUTPUT_EXPORTED) {
1263 if (defined($function_table{$name})) {
1264 return 1;
1265 } else {
1266 return 0;
1267 }
1268 }
1269 if ($output_selection == OUTPUT_INTERNAL) {
1270 if (!($functype eq "function" && defined($function_table{$name}))) {
1271 return 1;
1272 } else {
1273 return 0;
1274 }
1275 }
1276 if ($output_selection == OUTPUT_INCLUDE) {
1277 if (defined($function_table{$name})) {
1278 return 1;
1279 } else {
1280 return 0;
1281 }
1282 }
Mauro Carvalho Chehab85afe602017-12-30 22:32:55 -02001283 die("Please add the new output type at show_warnings()");
1284}
1285
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286sub dump_enum($$) {
1287 my $x = shift;
1288 my $file = shift;
Mauro Carvalho Chehabd38c8cf2020-10-01 08:23:52 +02001289 my $members;
1290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291
Martin Waitzaeec46b2005-11-13 16:08:13 -08001292 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Conchúr Navid4468e212015-11-08 10:48:05 +01001293 # strip #define macros inside enums
1294 $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
Randy Dunlapb6d676d2010-08-10 18:02:50 -07001295
Mauro Carvalho Chehabd38c8cf2020-10-01 08:23:52 +02001296 if ($x =~ /typedef\s+enum\s*\{(.*)\}\s*(\w*)\s*;/) {
1297 $declaration_name = $2;
1298 $members = $1;
1299 } elsif ($x =~ /enum\s+(\w*)\s*\{(.*)\}/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001300 $declaration_name = $1;
Mauro Carvalho Chehabd38c8cf2020-10-01 08:23:52 +02001301 $members = $2;
1302 }
1303
Andy Shevchenkoae5b17e2020-11-02 19:06:37 +02001304 if ($members) {
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001305 if ($identifier ne $declaration_name) {
Mauro Carvalho Chehab0b54c2e2021-03-03 09:42:14 +01001306 if ($identifier eq "") {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001307 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n");
Mauro Carvalho Chehab0b54c2e2021-03-03 09:42:14 +01001308 } else {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001309 emit_warning("${file}:$.", "expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n");
Mauro Carvalho Chehab0b54c2e2021-03-03 09:42:14 +01001310 }
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001311 return;
1312 }
Mauro Carvalho Chehab0b54c2e2021-03-03 09:42:14 +01001313 $declaration_name = "(anonymous)" if ($declaration_name eq "");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001314
Johannes Berg5cb5c312017-09-19 13:08:13 +02001315 my %_members;
1316
Markus Heiser463a0fd2017-06-16 21:27:48 +02001317 $members =~ s/\s+$//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
1319 foreach my $arg (split ',', $members) {
1320 $arg =~ s/^\s*(\w+).*/$1/;
1321 push @parameterlist, $arg;
1322 if (!$parameterdescs{$arg}) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001323 $parameterdescs{$arg} = $undescribed;
Mauro Carvalho Chehab85afe602017-12-30 22:32:55 -02001324 if (show_warnings("enum", $declaration_name)) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001325 emit_warning("${file}:$.", "Enum value '$arg' not described in enum '$declaration_name'\n");
Mauro Carvalho Chehab2defb272017-12-18 10:30:18 -02001326 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 }
Johannes Berg5cb5c312017-09-19 13:08:13 +02001328 $_members{$arg} = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001330
Johannes Berg5cb5c312017-09-19 13:08:13 +02001331 while (my ($k, $v) = each %parameterdescs) {
1332 if (!exists($_members{$k})) {
Mauro Carvalho Chehab85afe602017-12-30 22:32:55 -02001333 if (show_warnings("enum", $declaration_name)) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001334 emit_warning("${file}:$.", "Excess enum value '$k' description in '$declaration_name'\n");
Mauro Carvalho Chehab2defb272017-12-18 10:30:18 -02001335 }
Johannes Berg5cb5c312017-09-19 13:08:13 +02001336 }
1337 }
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 output_declaration($declaration_name,
1340 'enum',
1341 {'enum' => $declaration_name,
1342 'module' => $modulename,
1343 'parameterlist' => \@parameterlist,
1344 'parameterdescs' => \%parameterdescs,
1345 'sectionlist' => \@sectionlist,
1346 'sections' => \%sections,
1347 'purpose' => $declaration_purpose
1348 });
Mauro Carvalho Chehabd38c8cf2020-10-01 08:23:52 +02001349 } else {
Bart Van Assched40e1e62015-09-04 15:43:21 -07001350 print STDERR "${file}:$.: error: Cannot parse enum!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 ++$errors;
1352 }
1353}
1354
Mauro Carvalho Chehab7d2c6b12020-12-02 09:17:32 +01001355my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
Mauro Carvalho Chehab7efc6c42020-10-27 11:20:37 +01001356my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
1357my $typedef_args = qr { \s*\((.*)\); }x;
1358
1359my $typedef1 = qr { typedef$typedef_type\($typedef_ident\)$typedef_args }x;
1360my $typedef2 = qr { typedef$typedef_type$typedef_ident$typedef_args }x;
1361
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362sub dump_typedef($$) {
1363 my $x = shift;
1364 my $file = shift;
1365
Martin Waitzaeec46b2005-11-13 16:08:13 -08001366 $x =~ s@/\*.*?\*/@@gos; # strip comments.
Mauro Carvalho Chehab83766452015-10-08 16:14:45 -03001367
Mauro Carvalho Chehab7efc6c42020-10-27 11:20:37 +01001368 # Parse function typedef prototypes
1369 if ($x =~ $typedef1 || $x =~ $typedef2) {
Mauro Carvalho Chehab83766452015-10-08 16:14:45 -03001370 $return_type = $1;
1371 $declaration_name = $2;
1372 my $args = $3;
Mauro Carvalho Chehab6b809752020-10-27 11:20:36 +01001373 $return_type =~ s/^\s+//;
Mauro Carvalho Chehab83766452015-10-08 16:14:45 -03001374
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001375 if ($identifier ne $declaration_name) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001376 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001377 return;
1378 }
1379
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001380 create_parameterlist($args, ',', $file, $declaration_name);
Mauro Carvalho Chehab83766452015-10-08 16:14:45 -03001381
1382 output_declaration($declaration_name,
1383 'function',
1384 {'function' => $declaration_name,
Mauro Carvalho Chehab82801d02016-08-30 20:20:58 -03001385 'typedef' => 1,
Mauro Carvalho Chehab83766452015-10-08 16:14:45 -03001386 'module' => $modulename,
1387 'functiontype' => $return_type,
1388 'parameterlist' => \@parameterlist,
1389 'parameterdescs' => \%parameterdescs,
1390 'parametertypes' => \%parametertypes,
1391 'sectionlist' => \@sectionlist,
1392 'sections' => \%sections,
1393 'purpose' => $declaration_purpose
1394 });
1395 return;
1396 }
1397
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 while (($x =~ /\(*.\)\s*;$/) || ($x =~ /\[*.\]\s*;$/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001399 $x =~ s/\(*.\)\s*;$/;/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 $x =~ s/\[*.\]\s*;$/;/;
1401 }
1402
1403 if ($x =~ /typedef.*\s+(\w+)\s*;/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001404 $declaration_name = $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001406 if ($identifier ne $declaration_name) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001407 emit_warning("${file}:$.", "expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001408 return;
1409 }
1410
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 output_declaration($declaration_name,
1412 'typedef',
1413 {'typedef' => $declaration_name,
1414 'module' => $modulename,
1415 'sectionlist' => \@sectionlist,
1416 'sections' => \%sections,
1417 'purpose' => $declaration_purpose
1418 });
1419 }
1420 else {
Bart Van Assched40e1e62015-09-04 15:43:21 -07001421 print STDERR "${file}:$.: error: Cannot parse typedef!\n";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 ++$errors;
1423 }
1424}
1425
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001426sub save_struct_actual($) {
1427 my $actual = shift;
1428
1429 # strip all spaces from the actual param so that it looks like one string item
1430 $actual =~ s/\s*//g;
1431 $struct_actual = $struct_actual . $actual . " ";
1432}
1433
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001434sub create_parameterlist($$$$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 my $args = shift;
1436 my $splitter = shift;
1437 my $file = shift;
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001438 my $declaration_name = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 my $type;
1440 my $param;
1441
Martin Waitza6d3fe72006-01-09 20:53:55 -08001442 # temporarily replace commas inside function pointer definition
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301443 my $arg_expr = qr{\([^\),]+};
1444 while ($args =~ /$arg_expr,/) {
1445 $args =~ s/($arg_expr),/$1#/g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 }
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001447
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 foreach my $arg (split($splitter, $args)) {
1449 # strip comments
1450 $arg =~ s/\/\*.*\*\///;
Randy Dunlap3c308792007-05-08 00:24:39 -07001451 # strip leading/trailing spaces
1452 $arg =~ s/^\s*//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 $arg =~ s/\s*$//;
1454 $arg =~ s/\s+/ /;
1455
1456 if ($arg =~ /^#/) {
1457 # Treat preprocessor directive as a typeless variable just to fill
1458 # corresponding data structures "correctly". Catch it later in
1459 # output_* subs.
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001460 push_parameter($arg, "", "", $file);
Richard Kennedy00d62962008-02-23 15:24:01 -08001461 } elsif ($arg =~ m/\(.+\)\s*\(/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 # pointer-to-function
1463 $arg =~ tr/#/,/;
Aditya Srivastava336ced22021-02-17 20:26:25 +05301464 $arg =~ m/[^\(]+\(\*?\s*([\w\[\]\.]*)\s*\)/;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 $param = $1;
1466 $type = $arg;
Richard Kennedy00d62962008-02-23 15:24:01 -08001467 $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001468 save_struct_actual($param);
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001469 push_parameter($param, $type, $arg, $file, $declaration_name);
Martin Waitzaeec46b2005-11-13 16:08:13 -08001470 } elsif ($arg) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 $arg =~ s/\s*:\s*/:/g;
1472 $arg =~ s/\s*\[/\[/g;
1473
1474 my @args = split('\s*,\s*', $arg);
1475 if ($args[0] =~ m/\*/) {
1476 $args[0] =~ s/(\*+)\s*/ $1/;
1477 }
Borislav Petkov884f2812007-05-08 00:29:05 -07001478
1479 my @first_arg;
1480 if ($args[0] =~ /^(.*\s+)(.*?\[.*\].*)$/) {
1481 shift @args;
1482 push(@first_arg, split('\s+', $1));
1483 push(@first_arg, $2);
1484 } else {
1485 @first_arg = split('\s+', shift @args);
1486 }
1487
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 unshift(@args, pop @first_arg);
1489 $type = join " ", @first_arg;
1490
1491 foreach $param (@args) {
1492 if ($param =~ m/^(\*+)\s*(.*)/) {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001493 save_struct_actual($2);
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001494
1495 push_parameter($2, "$type $1", $arg, $file, $declaration_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 }
1497 elsif ($param =~ m/(.*?):(\d+)/) {
Randy Dunlap7b978872008-05-16 15:45:52 -07001498 if ($type ne "") { # skip unnamed bit-fields
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001499 save_struct_actual($1);
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001500 push_parameter($1, "$type:$2", $arg, $file, $declaration_name)
Randy Dunlap7b978872008-05-16 15:45:52 -07001501 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 }
1503 else {
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001504 save_struct_actual($param);
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001505 push_parameter($param, $type, $arg, $file, $declaration_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 }
1507 }
1508 }
1509 }
1510}
1511
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001512sub push_parameter($$$$$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 my $param = shift;
1514 my $type = shift;
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001515 my $org_arg = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 my $file = shift;
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001517 my $declaration_name = shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001519 if (($anon_struct_union == 1) && ($type eq "") &&
1520 ($param eq "}")) {
1521 return; # ignore the ending }; from anon. struct/union
1522 }
1523
1524 $anon_struct_union = 0;
Mauro Carvalho Chehabf9b5c532017-03-30 17:11:29 -03001525 $param =~ s/[\[\)].*//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Martin Waitza6d3fe72006-01-09 20:53:55 -08001527 if ($type eq "" && $param =~ /\.\.\.$/)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 {
Silvio Frickec950a172016-10-28 10:14:08 +02001529 if (!$param =~ /\w\.\.\.$/) {
1530 # handles unnamed variable parameters
1531 $param = "...";
1532 }
Jonathan Neuschäfer43756e32019-11-07 14:41:33 +01001533 elsif ($param =~ /\w\.\.\.$/) {
1534 # for named variable parameters of the form `x...`, remove the dots
1535 $param =~ s/\.\.\.$//;
1536 }
Randy Dunlapced69092008-12-01 13:14:03 -08001537 if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq "") {
1538 $parameterdescs{$param} = "variable arguments";
1539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 }
1541 elsif ($type eq "" && ($param eq "" or $param eq "void"))
1542 {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 $param="void";
1544 $parameterdescs{void} = "no arguments";
1545 }
Randy Dunlap134fe012006-12-22 01:10:50 -08001546 elsif ($type eq "" && ($param eq "struct" or $param eq "union"))
1547 # handle unnamed (anonymous) union or struct:
1548 {
1549 $type = $param;
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001550 $param = "{unnamed_" . $param . "}";
Randy Dunlap134fe012006-12-22 01:10:50 -08001551 $parameterdescs{$param} = "anonymous\n";
Randy Dunlap5f8c7c92007-07-19 01:48:24 -07001552 $anon_struct_union = 1;
Randy Dunlap134fe012006-12-22 01:10:50 -08001553 }
1554
Martin Waitza6d3fe72006-01-09 20:53:55 -08001555 # warn if parameter has no description
Randy Dunlap134fe012006-12-22 01:10:50 -08001556 # (but ignore ones starting with # as these are not parameters
1557 # but inline preprocessor statements);
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001558 # Note: It will also ignore void params and unnamed structs/unions
Mauro Carvalho Chehabf9b5c532017-03-30 17:11:29 -03001559 if (!defined $parameterdescs{$param} && $param !~ /^#/) {
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001560 $parameterdescs{$param} = $undescribed;
Martin Waitza6d3fe72006-01-09 20:53:55 -08001561
Jonathan Corbetbe5cd20c2019-01-11 12:31:39 -07001562 if (show_warnings($type, $declaration_name) && $param !~ /\./) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001563 emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n");
Mauro Carvalho Chehab2defb272017-12-18 10:30:18 -02001564 }
Randy Dunlap3c308792007-05-08 00:24:39 -07001565 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001567 # strip spaces from $param so that it is one continuous string
Randy Dunlape34e7db2009-06-17 17:37:47 -07001568 # on @parameterlist;
1569 # this fixes a problem where check_sections() cannot find
1570 # a parameter like "addr[6 + 2]" because it actually appears
1571 # as "addr[6", "+", "2]" on the parameter list;
1572 # but it's better to maintain the param string unchanged for output,
1573 # so just weaken the string compare in check_sections() to ignore
1574 # "[blah" in a parameter string;
1575 ###$param =~ s/\s*//g;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 push @parameterlist, $param;
Mauro Carvalho Chehabed8348e2020-09-30 12:24:43 +02001577 $org_arg =~ s/\s\s+/ /g;
1578 $parametertypes{$param} = $org_arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579}
1580
Mauro Carvalho Chehab1081de22017-12-18 10:30:14 -02001581sub check_sections($$$$$) {
1582 my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) = @_;
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001583 my @sects = split ' ', $sectcheck;
1584 my @prms = split ' ', $prmscheck;
1585 my $err;
1586 my ($px, $sx);
1587 my $prm_clean; # strip trailing "[array size]" and/or beginning "*"
1588
1589 foreach $sx (0 .. $#sects) {
1590 $err = 1;
1591 foreach $px (0 .. $#prms) {
1592 $prm_clean = $prms[$px];
1593 $prm_clean =~ s/\[.*\]//;
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301594 $prm_clean =~ s/$attribute//i;
Randy Dunlape34e7db2009-06-17 17:37:47 -07001595 # ignore array size in a parameter string;
1596 # however, the original param string may contain
1597 # spaces, e.g.: addr[6 + 2]
1598 # and this appears in @prms as "addr[6" since the
1599 # parameter list is split at spaces;
1600 # hence just ignore "[..." for the sections check;
1601 $prm_clean =~ s/\[.*//;
1602
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001603 ##$prm_clean =~ s/^\**//;
1604 if ($prm_clean eq $sects[$sx]) {
1605 $err = 0;
1606 last;
1607 }
1608 }
1609 if ($err) {
1610 if ($decl_type eq "function") {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001611 emit_warning("${file}:$.",
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001612 "Excess function parameter " .
1613 "'$sects[$sx]' " .
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001614 "description in '$decl_name'\n");
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001615 }
1616 }
1617 }
1618}
1619
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620##
Yacine Belkadi4092bac2012-11-26 22:22:27 +01001621# Checks the section describing the return value of a function.
1622sub check_return_section {
1623 my $file = shift;
1624 my $declaration_name = shift;
1625 my $return_type = shift;
1626
1627 # Ignore an empty return type (It's a macro)
1628 # Ignore functions with a "void" return type. (But don't ignore "void *")
1629 if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
1630 return;
1631 }
1632
1633 if (!defined($sections{$section_return}) ||
1634 $sections{$section_return} eq "") {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001635 emit_warning("${file}:$.",
Yacine Belkadi4092bac2012-11-26 22:22:27 +01001636 "No description found for return value of " .
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001637 "'$declaration_name'\n");
Yacine Belkadi4092bac2012-11-26 22:22:27 +01001638 }
1639}
1640
1641##
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642# takes a function prototype and the name of the current file being
1643# processed and spits out all the details stored in the global
1644# arrays/hashes.
1645sub dump_function($$) {
1646 my $prototype = shift;
1647 my $file = shift;
Horia Geantacbb4d3e2014-07-12 09:55:03 -07001648 my $noret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Mauro Carvalho Chehab5ef09c92020-10-09 10:15:25 +02001650 print_lineno($new_start_line);
Mauro Carvalho Chehab5eb6b4b2020-09-09 16:10:33 +02001651
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 $prototype =~ s/^static +//;
1653 $prototype =~ s/^extern +//;
Pavel Pisa4dc3b162005-05-01 08:59:25 -07001654 $prototype =~ s/^asmlinkage +//;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 $prototype =~ s/^inline +//;
1656 $prototype =~ s/^__inline__ +//;
Randy Dunlap32e79402006-10-11 01:22:10 -07001657 $prototype =~ s/^__inline +//;
1658 $prototype =~ s/^__always_inline +//;
1659 $prototype =~ s/^noinline +//;
Randy Dunlap74fc5c62008-06-19 16:03:29 -07001660 $prototype =~ s/__init +//;
Randy Dunlap20072202010-03-23 13:35:24 -07001661 $prototype =~ s/__init_or_module +//;
Matthew Wilcox80342d42021-04-27 12:48:28 +01001662 $prototype =~ s/__deprecated +//;
Aditya Srivastava084aa002021-03-06 17:05:10 +05301663 $prototype =~ s/__flatten +//;
Randy Dunlap270a0092014-08-24 18:17:17 -07001664 $prototype =~ s/__meminit +//;
Randy Dunlap70c95b02012-01-21 10:31:54 -08001665 $prototype =~ s/__must_check +//;
Randy Dunlap0df7c0e2012-08-16 16:23:20 -07001666 $prototype =~ s/__weak +//;
Matthew Wilcox0891f952018-03-15 05:06:23 -07001667 $prototype =~ s/__sched +//;
Randy Dunlap95e760c2019-08-05 09:29:50 -07001668 $prototype =~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//;
Kees Cooka40a8a12021-10-11 11:06:50 -07001669 $prototype =~ s/__alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +//;
Horia Geantacbb4d3e2014-07-12 09:55:03 -07001670 my $define = $prototype =~ s/^#\s*define\s+//; #ak added
Aditya Srivastava084aa002021-03-06 17:05:10 +05301671 $prototype =~ s/__attribute_const__ +//;
Paolo Bonzinib1aaa542017-01-02 16:22:24 +01001672 $prototype =~ s/__attribute__\s*\(\(
1673 (?:
1674 [\w\s]++ # attribute name
1675 (?:\([^)]*+\))? # attribute arguments
1676 \s*+,? # optional comma at the end
1677 )+
1678 \)\)\s+//x;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 # Yes, this truly is vile. We are looking for:
1681 # 1. Return type (may be nothing if we're looking at a macro)
1682 # 2. Function name
1683 # 3. Function parameters.
1684 #
1685 # All the while we have to watch out for function pointer parameters
1686 # (which IIRC is what the two sections are for), C types (these
1687 # regexps don't even start to express all the possibilities), and
1688 # so on.
1689 #
1690 # If you mess with these regexps, it's a good idea to check that
1691 # the following functions' documentation still comes out right:
1692 # - parport_register_device (function pointer parameters)
1693 # - atomic_set (macro)
Martin Waitz9598f912006-02-01 03:06:55 -08001694 # - pci_match_device, __copy_to_user (long return type)
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301695 my $name = qr{[a-zA-Z0-9_~:]+};
1696 my $prototype_end1 = qr{[^\(]*};
1697 my $prototype_end2 = qr{[^\{]*};
1698 my $prototype_end = qr{\(($prototype_end1|$prototype_end2)\)};
1699 my $type1 = qr{[\w\s]+};
1700 my $type2 = qr{$type1\*+};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301702 if ($define && $prototype =~ m/^()($name)\s+/) {
Horia Geantacbb4d3e2014-07-12 09:55:03 -07001703 # This is an object-like macro, it has no return type and no parameter
1704 # list.
1705 # Function-like macros are not allowed to have spaces between
1706 # declaration_name and opening parenthesis (notice the \s+).
1707 $return_type = $1;
1708 $declaration_name = $2;
1709 $noret = 1;
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301710 } elsif ($prototype =~ m/^()($name)\s*$prototype_end/ ||
1711 $prototype =~ m/^($type1)\s+($name)\s*$prototype_end/ ||
1712 $prototype =~ m/^($type2+)\s*($name)\s*$prototype_end/) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 $return_type = $1;
1714 $declaration_name = $2;
1715 my $args = $3;
1716
Mauro Carvalho Chehab151c4682017-12-18 10:30:15 -02001717 create_parameterlist($args, ',', $file, $declaration_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 } else {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001719 emit_warning("${file}:$.", "cannot understand function prototype: '$prototype'\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 return;
1721 }
1722
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001723 if ($identifier ne $declaration_name) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001724 emit_warning("${file}:$.", "expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001725 return;
1726 }
1727
Mauro Carvalho Chehab47bcacf2020-09-30 09:47:01 +02001728 my $prms = join " ", @parameterlist;
1729 check_sections($file, $declaration_name, "function", $sectcheck, $prms);
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001730
Mauro Carvalho Chehab47bcacf2020-09-30 09:47:01 +02001731 # This check emits a lot of warnings at the moment, because many
1732 # functions don't have a 'Return' doc section. So until the number
1733 # of warnings goes sufficiently down, the check is only performed in
1734 # verbose mode.
1735 # TODO: always perform the check.
1736 if ($verbose && !$noret) {
1737 check_return_section($file, $declaration_name, $return_type);
1738 }
Yacine Belkadi4092bac2012-11-26 22:22:27 +01001739
Mauro Carvalho Chehab47bcacf2020-09-30 09:47:01 +02001740 # The function parser can be called with a typedef parameter.
1741 # Handle it.
1742 if ($return_type =~ /typedef/) {
1743 output_declaration($declaration_name,
1744 'function',
1745 {'function' => $declaration_name,
1746 'typedef' => 1,
1747 'module' => $modulename,
1748 'functiontype' => $return_type,
1749 'parameterlist' => \@parameterlist,
1750 'parameterdescs' => \%parameterdescs,
1751 'parametertypes' => \%parametertypes,
1752 'sectionlist' => \@sectionlist,
1753 'sections' => \%sections,
1754 'purpose' => $declaration_purpose
1755 });
1756 } else {
1757 output_declaration($declaration_name,
1758 'function',
1759 {'function' => $declaration_name,
1760 'module' => $modulename,
1761 'functiontype' => $return_type,
1762 'parameterlist' => \@parameterlist,
1763 'parameterdescs' => \%parameterdescs,
1764 'parametertypes' => \%parametertypes,
1765 'sectionlist' => \@sectionlist,
1766 'sections' => \%sections,
1767 'purpose' => $declaration_purpose
1768 });
1769 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770}
1771
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772sub reset_state {
1773 $function = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 %parameterdescs = ();
1775 %parametertypes = ();
1776 @parameterlist = ();
1777 %sections = ();
1778 @sectionlist = ();
Randy Dunlapa1d94aa2008-12-19 08:49:30 -08001779 $sectcheck = "";
1780 $struct_actual = "";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 $prototype = "";
Randy Dunlap3c3b8092006-02-01 03:06:58 -08001782
Jani Nikula48af6062016-05-26 14:56:05 +03001783 $state = STATE_NORMAL;
1784 $inline_doc_state = STATE_INLINE_NA;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785}
1786
Jason Baron56afb0f2009-04-30 13:29:36 -04001787sub tracepoint_munge($) {
1788 my $file = shift;
1789 my $tracepointname = 0;
1790 my $tracepointargs = 0;
1791
Jason Baron3a9089f2009-12-01 12:18:49 -05001792 if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001793 $tracepointname = $1;
1794 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001795 if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
1796 $tracepointname = $1;
1797 }
1798 if ($prototype =~ m/DEFINE_EVENT\((.*?),(.*?),/) {
1799 $tracepointname = $2;
1800 }
1801 $tracepointname =~ s/^\s+//; #strip leading whitespace
1802 if ($prototype =~ m/TP_PROTO\((.*?)\)/) {
Jason Baron56afb0f2009-04-30 13:29:36 -04001803 $tracepointargs = $1;
1804 }
1805 if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02001806 emit_warning("${file}:$.", "Unrecognized tracepoint format: \n".
1807 "$prototype\n");
Jason Baron56afb0f2009-04-30 13:29:36 -04001808 } else {
1809 $prototype = "static inline void trace_$tracepointname($tracepointargs)";
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001810 $identifier = "trace_$identifier";
Jason Baron56afb0f2009-04-30 13:29:36 -04001811 }
1812}
1813
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001814sub syscall_munge() {
1815 my $void = 0;
1816
Mauro Carvalho Chehab7c9aa012017-12-18 10:30:12 -02001817 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/CR's
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001818## if ($prototype =~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) {
1819 if ($prototype =~ m/SYSCALL_DEFINE0/) {
1820 $void = 1;
1821## $prototype = "long sys_$1(void)";
1822 }
1823
1824 $prototype =~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func name
1825 if ($prototype =~ m/long (sys_.*?),/) {
1826 $prototype =~ s/,/\(/;
1827 } elsif ($void) {
1828 $prototype =~ s/\)/\(void\)/;
1829 }
1830
1831 # now delete all of the odd-number commas in $prototype
1832 # so that arg types & arg names don't have a comma between them
1833 my $count = 0;
1834 my $len = length($prototype);
1835 if ($void) {
1836 $len = 0; # skip the for-loop
1837 }
1838 for (my $ix = 0; $ix < $len; $ix++) {
1839 if (substr($prototype, $ix, 1) eq ',') {
1840 $count++;
1841 if ($count % 2 == 1) {
1842 substr($prototype, $ix, 1) = ' ';
1843 }
1844 }
1845 }
1846}
1847
Daniel Vetterb7afa922016-06-01 23:46:24 +02001848sub process_proto_function($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 my $x = shift;
1850 my $file = shift;
1851
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001852 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1853
Randy Dunlap890c78c2008-10-25 17:06:43 -07001854 if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#\s*define/)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 # do nothing
1856 }
1857 elsif ($x =~ /([^\{]*)/) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001858 $prototype .= $1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001860
Randy Dunlap890c78c2008-10-25 17:06:43 -07001861 if (($x =~ /\{/) || ($x =~ /\#\s*define/) || ($x =~ /;/)) {
Randy Dunlap3c308792007-05-08 00:24:39 -07001862 $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1864 $prototype =~ s@^\s+@@gos; # strip leading spaces
Mauro Carvalho Chehab7ae281b2020-06-23 09:09:02 +02001865
1866 # Handle prototypes for function pointers like:
1867 # int (*pcs_config)(struct foo)
1868 $prototype =~ s@^(\S+\s+)\(\s*\*(\S+)\)@$1$2@gos;
1869
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001870 if ($prototype =~ /SYSCALL_DEFINE/) {
1871 syscall_munge();
1872 }
Jason Baron3a9089f2009-12-01 12:18:49 -05001873 if ($prototype =~ /TRACE_EVENT/ || $prototype =~ /DEFINE_EVENT/ ||
1874 $prototype =~ /DEFINE_SINGLE_EVENT/)
1875 {
Jason Baron56afb0f2009-04-30 13:29:36 -04001876 tracepoint_munge($file);
1877 }
Randy Dunlapb4870bc2009-02-11 13:04:33 -08001878 dump_function($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879 reset_state();
1880 }
1881}
1882
Daniel Vetterb7afa922016-06-01 23:46:24 +02001883sub process_proto_type($$) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 my $x = shift;
1885 my $file = shift;
1886
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 $x =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
1888 $x =~ s@^\s+@@gos; # strip leading spaces
1889 $x =~ s@\s+$@@gos; # strip trailing spaces
Randy Dunlap51f5a0c2007-07-19 01:48:24 -07001890 $x =~ s@\/\/.*$@@gos; # strip C99-style comments to end of line
1891
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 if ($x =~ /^#/) {
1893 # To distinguish preprocessor directive from regular declaration later.
1894 $x .= ";";
1895 }
1896
1897 while (1) {
Ben Hutchings673bb2d2018-08-05 17:41:09 +01001898 if ( $x =~ /([^\{\};]*)([\{\};])(.*)/ ) {
Markus Heiser463a0fd2017-06-16 21:27:48 +02001899 if( length $prototype ) {
1900 $prototype .= " "
1901 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 $prototype .= $1 . $2;
1903 ($2 eq '{') && $brcount++;
1904 ($2 eq '}') && $brcount--;
1905 if (($2 eq ';') && ($brcount == 0)) {
Randy Dunlapb9d973282009-06-09 08:50:38 -07001906 dump_declaration($prototype, $file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 reset_state();
Randy Dunlap3c308792007-05-08 00:24:39 -07001908 last;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 }
1910 $x = $3;
Randy Dunlap3c308792007-05-08 00:24:39 -07001911 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 $prototype .= $x;
1913 last;
1914 }
1915 }
1916}
1917
Randy Dunlap6b5b55f2007-10-16 23:31:20 -07001918
Jani Nikula1ad560e2016-06-07 10:53:39 +03001919sub map_filename($) {
1920 my $file;
1921 my ($orig_file) = @_;
1922
1923 if (defined($ENV{'SRCTREE'})) {
1924 $file = "$ENV{'SRCTREE'}" . "/" . $orig_file;
1925 } else {
1926 $file = $orig_file;
1927 }
1928
1929 if (defined($source_map{$file})) {
1930 $file = $source_map{$file};
1931 }
1932
1933 return $file;
1934}
1935
Jani Nikula88c2b572016-06-07 11:00:52 +03001936sub process_export_file($) {
1937 my ($orig_file) = @_;
1938 my $file = map_filename($orig_file);
1939
1940 if (!open(IN,"<$file")) {
1941 print STDERR "Error: Cannot open file $file\n";
1942 ++$errors;
1943 return;
1944 }
1945
1946 while (<IN>) {
1947 if (/$export_symbol/) {
Mauro Carvalho Chehabeab795d2020-09-29 14:23:39 +02001948 next if (defined($nosymbol_table{$2}));
Jani Nikula88c2b572016-06-07 11:00:52 +03001949 $function_table{$2} = 1;
1950 }
1951 }
1952
1953 close(IN);
1954}
1955
Jonathan Corbet07048d12018-02-05 14:15:19 -07001956#
1957# Parsers for the various processing states.
1958#
1959# STATE_NORMAL: looking for the /** to begin everything.
1960#
1961sub process_normal() {
1962 if (/$doc_start/o) {
1963 $state = STATE_NAME; # next line is always the function name
1964 $in_doc_sect = 0;
1965 $declaration_start_line = $. + 1;
1966 }
1967}
1968
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001969#
1970# STATE_NAME: Looking for the "name - description" line
1971#
1972sub process_name($$) {
1973 my $file = shift;
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001974 my $descr;
Jonathan Corbet07048d12018-02-05 14:15:19 -07001975
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001976 if (/$doc_block/o) {
1977 $state = STATE_DOCBLOCK;
1978 $contents = "";
Mauro Carvalho Chehab5ef09c92020-10-09 10:15:25 +02001979 $new_start_line = $.;
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001980
1981 if ( $1 eq "" ) {
1982 $section = $section_intro;
1983 } else {
1984 $section = $1;
1985 }
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001986 } elsif (/$doc_decl/o) {
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001987 $identifier = $1;
Aditya Srivastava3e58e832021-03-29 14:59:45 +05301988 my $is_kernel_comment = 0;
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301989 my $decl_start = qr{$doc_com};
Aditya Srivastavaf9bbc122021-04-15 00:55:29 +05301990 # test for pointer declaration type, foo * bar() - desc
1991 my $fn_type = qr{\w+\s*\*\s*};
1992 my $parenthesis = qr{\(\w*\)};
1993 my $decl_end = qr{[-:].*};
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05301994 if (/^$decl_start([\w\s]+?)$parenthesis?\s*$decl_end?$/) {
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07001995 $identifier = $1;
1996 }
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01001997 if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
1998 $decl_type = $1;
1999 $identifier = $2;
Aditya Srivastava3e58e832021-03-29 14:59:45 +05302000 $is_kernel_comment = 1;
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01002001 }
Aditya Srivastavaf9bbc122021-04-15 00:55:29 +05302002 # Look for foo() or static void foo() - description; or misspelt
2003 # identifier
Aditya Srivastavae86bdb22021-05-14 20:12:44 +05302004 elsif (/^$decl_start$fn_type?(\w+)\s*$parenthesis?\s*$decl_end?$/ ||
2005 /^$decl_start$fn_type?(\w+.*)$parenthesis?\s*$decl_end$/) {
Aditya Srivastavaf9bbc122021-04-15 00:55:29 +05302006 $identifier = $1;
2007 $decl_type = 'function';
2008 $identifier =~ s/^define\s+//;
2009 $is_kernel_comment = 1;
2010 }
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01002011 $identifier =~ s/\s+$//;
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002012
2013 $state = STATE_BODY;
2014 # if there's no @param blocks need to set up default section
2015 # here
2016 $contents = "";
2017 $section = $section_default;
2018 $new_start_line = $. + 1;
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01002019 if (/[-:](.*)/) {
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002020 # strip leading/trailing/multiple spaces
2021 $descr= $1;
2022 $descr =~ s/^\s*//;
2023 $descr =~ s/\s*$//;
2024 $descr =~ s/\s+/ /g;
2025 $declaration_purpose = $descr;
2026 $state = STATE_BODY_MAYBE;
2027 } else {
2028 $declaration_purpose = "";
2029 }
2030
Aditya Srivastava3e58e832021-03-29 14:59:45 +05302031 if (!$is_kernel_comment) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002032 emit_warning("${file}:$.", "This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n$_");
Aditya Srivastava3e58e832021-03-29 14:59:45 +05302033 $state = STATE_NORMAL;
2034 }
2035
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002036 if (($declaration_purpose eq "") && $verbose) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002037 emit_warning("${file}:$.", "missing initial short description on line:\n$_");
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002038 }
2039
Mauro Carvalho Chehab0b54c2e2021-03-03 09:42:14 +01002040 if ($identifier eq "" && $decl_type ne "enum") {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002041 emit_warning("${file}:$.", "wrong kernel-doc identifier on line:\n$_");
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01002042 $state = STATE_NORMAL;
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002043 }
2044
2045 if ($verbose) {
Mauro Carvalho Chehab52042e22021-01-14 09:04:47 +01002046 print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002047 }
2048 } else {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002049 emit_warning("${file}:$.", "Cannot understand $_ on line $. - I thought it was a doc line\n");
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002050 $state = STATE_NORMAL;
2051 }
2052}
Jonathan Corbet07048d12018-02-05 14:15:19 -07002053
Jonathan Corbetd742f242018-02-05 15:36:05 -07002054
2055#
2056# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment.
2057#
2058sub process_body($$) {
2059 my $file = shift;
2060
Jonathan Neuschäfer43756e32019-11-07 14:41:33 +01002061 # Until all named variable macro parameters are
2062 # documented using the bare name (`x`) rather than with
2063 # dots (`x...`), strip the dots:
2064 if ($section =~ /\w\.\.\.$/) {
2065 $section =~ s/\.\.\.$//;
2066
2067 if ($verbose) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002068 emit_warning("${file}:$.", "Variable macro arguments should be documented without dots\n");
Jonathan Neuschäfer43756e32019-11-07 14:41:33 +01002069 }
2070 }
2071
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002072 if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
2073 dump_section($file, $section, $contents);
2074 $section = $section_default;
Mauro Carvalho Chehab5ef09c92020-10-09 10:15:25 +02002075 $new_start_line = $.;
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002076 $contents = "";
2077 }
2078
Jonathan Corbetd742f242018-02-05 15:36:05 -07002079 if (/$doc_sect/i) { # case insensitive for supported section names
2080 $newsection = $1;
2081 $newcontents = $2;
2082
2083 # map the supported section names to the canonical names
2084 if ($newsection =~ m/^description$/i) {
2085 $newsection = $section_default;
2086 } elsif ($newsection =~ m/^context$/i) {
2087 $newsection = $section_context;
2088 } elsif ($newsection =~ m/^returns?$/i) {
2089 $newsection = $section_return;
2090 } elsif ($newsection =~ m/^\@return$/) {
2091 # special: @return is a section, not a param description
2092 $newsection = $section_return;
2093 }
2094
2095 if (($contents ne "") && ($contents ne "\n")) {
2096 if (!$in_doc_sect && $verbose) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002097 emit_warning("${file}:$.", "contents before sections\n");
Jonathan Corbetd742f242018-02-05 15:36:05 -07002098 }
2099 dump_section($file, $section, $contents);
2100 $section = $section_default;
2101 }
2102
2103 $in_doc_sect = 1;
2104 $state = STATE_BODY;
2105 $contents = $newcontents;
2106 $new_start_line = $.;
2107 while (substr($contents, 0, 1) eq " ") {
2108 $contents = substr($contents, 1);
2109 }
2110 if ($contents ne "") {
2111 $contents .= "\n";
2112 }
2113 $section = $newsection;
2114 $leading_space = undef;
2115 } elsif (/$doc_end/) {
2116 if (($contents ne "") && ($contents ne "\n")) {
2117 dump_section($file, $section, $contents);
2118 $section = $section_default;
2119 $contents = "";
2120 }
2121 # look for doc_com + <text> + doc_end:
2122 if ($_ =~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002123 emit_warning("${file}:$.", "suspicious ending line: $_");
Jonathan Corbetd742f242018-02-05 15:36:05 -07002124 }
2125
2126 $prototype = "";
2127 $state = STATE_PROTO;
2128 $brcount = 0;
Mauro Carvalho Chehab5ef09c92020-10-09 10:15:25 +02002129 $new_start_line = $. + 1;
Jonathan Corbetd742f242018-02-05 15:36:05 -07002130 } elsif (/$doc_content/) {
Jonathan Corbetd742f242018-02-05 15:36:05 -07002131 if ($1 eq "") {
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002132 if ($section eq $section_context) {
Jonathan Corbetd742f242018-02-05 15:36:05 -07002133 dump_section($file, $section, $contents);
2134 $section = $section_default;
2135 $contents = "";
2136 $new_start_line = $.;
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002137 $state = STATE_BODY;
Jonathan Corbetd742f242018-02-05 15:36:05 -07002138 } else {
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002139 if ($section ne $section_default) {
2140 $state = STATE_BODY_WITH_BLANK_LINE;
2141 } else {
2142 $state = STATE_BODY;
2143 }
Jonathan Corbetd742f242018-02-05 15:36:05 -07002144 $contents .= "\n";
2145 }
Jonathan Corbetd742f242018-02-05 15:36:05 -07002146 } elsif ($state == STATE_BODY_MAYBE) {
2147 # Continued declaration purpose
2148 chomp($declaration_purpose);
2149 $declaration_purpose .= " " . $1;
2150 $declaration_purpose =~ s/\s+/ /g;
2151 } else {
2152 my $cont = $1;
2153 if ($section =~ m/^@/ || $section eq $section_context) {
2154 if (!defined $leading_space) {
2155 if ($cont =~ m/^(\s+)/) {
2156 $leading_space = $1;
2157 } else {
2158 $leading_space = "";
2159 }
2160 }
2161 $cont =~ s/^$leading_space//;
2162 }
2163 $contents .= $cont . "\n";
2164 }
2165 } else {
2166 # i dont know - bad line? ignore.
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002167 emit_warning("${file}:$.", "bad line: $_");
Jonathan Corbetd742f242018-02-05 15:36:05 -07002168 }
2169}
2170
2171
Jonathan Corbetcc794812018-02-05 15:46:30 -07002172#
2173# STATE_PROTO: reading a function/whatever prototype.
2174#
2175sub process_proto($$) {
2176 my $file = shift;
2177
2178 if (/$doc_inline_oneline/) {
2179 $section = $1;
2180 $contents = $2;
2181 if ($contents ne "") {
2182 $contents .= "\n";
2183 dump_section($file, $section, $contents);
2184 $section = $section_default;
2185 $contents = "";
2186 }
2187 } elsif (/$doc_inline_start/) {
2188 $state = STATE_INLINE;
2189 $inline_doc_state = STATE_INLINE_NAME;
2190 } elsif ($decl_type eq 'function') {
2191 process_proto_function($_, $file);
2192 } else {
2193 process_proto_type($_, $file);
2194 }
2195}
2196
Jonathan Corbetc17add52018-02-05 16:11:47 -07002197#
2198# STATE_DOCBLOCK: within a DOC: block.
2199#
2200sub process_docblock($$) {
2201 my $file = shift;
2202
2203 if (/$doc_end/) {
2204 dump_doc_section($file, $section, $contents);
2205 $section = $section_default;
2206 $contents = "";
2207 $function = "";
2208 %parameterdescs = ();
2209 %parametertypes = ();
2210 @parameterlist = ();
2211 %sections = ();
2212 @sectionlist = ();
2213 $prototype = "";
2214 $state = STATE_NORMAL;
2215 } elsif (/$doc_content/) {
2216 if ( $1 eq "" ) {
2217 $contents .= $blankline;
2218 } else {
2219 $contents .= $1 . "\n";
2220 }
2221 }
2222}
2223
2224#
2225# STATE_INLINE: docbook comments within a prototype.
2226#
2227sub process_inline($$) {
2228 my $file = shift;
2229
2230 # First line (state 1) needs to be a @parameter
2231 if ($inline_doc_state == STATE_INLINE_NAME && /$doc_inline_sect/o) {
2232 $section = $1;
2233 $contents = $2;
2234 $new_start_line = $.;
2235 if ($contents ne "") {
2236 while (substr($contents, 0, 1) eq " ") {
2237 $contents = substr($contents, 1);
2238 }
2239 $contents .= "\n";
2240 }
2241 $inline_doc_state = STATE_INLINE_TEXT;
2242 # Documentation block end */
2243 } elsif (/$doc_inline_end/) {
2244 if (($contents ne "") && ($contents ne "\n")) {
2245 dump_section($file, $section, $contents);
2246 $section = $section_default;
2247 $contents = "";
2248 }
2249 $state = STATE_PROTO;
2250 $inline_doc_state = STATE_INLINE_NA;
2251 # Regular text
2252 } elsif (/$doc_content/) {
2253 if ($inline_doc_state == STATE_INLINE_TEXT) {
2254 $contents .= $1 . "\n";
2255 # nuke leading blank lines
2256 if ($contents =~ /^\s*$/) {
2257 $contents = "";
2258 }
2259 } elsif ($inline_doc_state == STATE_INLINE_NAME) {
2260 $inline_doc_state = STATE_INLINE_ERROR;
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002261 emit_warning("${file}:$.", "Incorrect use of kernel-doc format: $_");
Jonathan Corbetc17add52018-02-05 16:11:47 -07002262 }
2263 }
2264}
2265
Jonathan Corbetcc794812018-02-05 15:46:30 -07002266
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267sub process_file($) {
Randy Dunlap2283a112005-07-07 15:39:26 -07002268 my $file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269 my $initial_section_counter = $section_counter;
Ben Hutchings68f86662015-09-01 23:48:49 +01002270 my ($orig_file) = @_;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271
Jani Nikula1ad560e2016-06-07 10:53:39 +03002272 $file = map_filename($orig_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Mauro Carvalho Chehabdbe8ba02020-09-28 12:52:34 +02002274 if (!open(IN_FILE,"<$file")) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 print STDERR "Error: Cannot open file $file\n";
2276 ++$errors;
2277 return;
2278 }
2279
Ilya Dryomova9e73142010-02-26 13:05:47 -08002280 $. = 1;
2281
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 $section_counter = 0;
Mauro Carvalho Chehabdbe8ba02020-09-28 12:52:34 +02002283 while (<IN_FILE>) {
Daniel Santos65478422012-10-04 17:15:05 -07002284 while (s/\\\s*$//) {
Mauro Carvalho Chehabdbe8ba02020-09-28 12:52:34 +02002285 $_ .= <IN_FILE>;
Daniel Santos65478422012-10-04 17:15:05 -07002286 }
Mauro Carvalho Chehab7c9aa012017-12-18 10:30:12 -02002287 # Replace tabs by spaces
2288 while ($_ =~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {};
Jonathan Corbetc17add52018-02-05 16:11:47 -07002289 # Hand this line to the appropriate state handler
Jani Nikula48af6062016-05-26 14:56:05 +03002290 if ($state == STATE_NORMAL) {
Jonathan Corbet07048d12018-02-05 14:15:19 -07002291 process_normal();
Jonathan Corbet3cac2bc2018-02-05 14:36:33 -07002292 } elsif ($state == STATE_NAME) {
2293 process_name($file, $_);
Mauro Carvalho Chehab0d55d482020-04-14 18:48:29 +02002294 } elsif ($state == STATE_BODY || $state == STATE_BODY_MAYBE ||
2295 $state == STATE_BODY_WITH_BLANK_LINE) {
Jonathan Corbetd742f242018-02-05 15:36:05 -07002296 process_body($file, $_);
Jani Nikula48af6062016-05-26 14:56:05 +03002297 } elsif ($state == STATE_INLINE) { # scanning for inline parameters
Jonathan Corbetc17add52018-02-05 16:11:47 -07002298 process_inline($file, $_);
Jonathan Corbetcc794812018-02-05 15:46:30 -07002299 } elsif ($state == STATE_PROTO) {
2300 process_proto($file, $_);
Jani Nikula48af6062016-05-26 14:56:05 +03002301 } elsif ($state == STATE_DOCBLOCK) {
Jonathan Corbetc17add52018-02-05 16:11:47 -07002302 process_docblock($file, $_);
Randy Dunlap3c308792007-05-08 00:24:39 -07002303 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 }
Jonathan Corbetc17add52018-02-05 16:11:47 -07002305
2306 # Make sure we got something interesting.
Jonathan Corbetb0d60bf2019-05-24 14:52:01 -06002307 if ($initial_section_counter == $section_counter && $
2308 output_mode ne "none") {
2309 if ($output_selection == OUTPUT_INCLUDE) {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002310 emit_warning("${file}:1", "'$_' not found\n")
Jonathan Corbetb0d60bf2019-05-24 14:52:01 -06002311 for keys %function_table;
Matthew Wilcox3a025e12017-11-20 10:40:40 -08002312 }
Jonathan Corbetb0d60bf2019-05-24 14:52:01 -06002313 else {
Niklas Söderlunddf4bf982022-06-13 11:05:10 +02002314 emit_warning("${file}:1", "no structured comments found\n");
Johannes Berge946c43a2013-11-12 15:11:12 -08002315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316 }
Mauro Carvalho Chehabdbe8ba02020-09-28 12:52:34 +02002317 close IN_FILE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318}
Randy Dunlap8484baa2011-01-05 16:28:43 -08002319
2320
Mauro Carvalho Chehab93351d42020-10-04 09:44:28 +02002321if ($output_mode eq "rst") {
2322 get_sphinx_version() if (!$sphinx_major);
2323}
2324
Randy Dunlap8484baa2011-01-05 16:28:43 -08002325$kernelversion = get_kernel_version();
2326
2327# generate a sequence of code that will splice in highlighting information
2328# using the s// operator.
Mauro Carvalho Chehab1ef06232015-11-17 13:29:49 -02002329for (my $k = 0; $k < @highlights; $k++) {
Danilo Cesar Lemes de Paula4d732702015-09-07 17:01:59 -03002330 my $pattern = $highlights[$k][0];
2331 my $result = $highlights[$k][1];
2332# print STDERR "scanning pattern:$pattern, highlight:($result)\n";
2333 $dohighlight .= "\$contents =~ s:$pattern:$result:gs;\n";
Randy Dunlap8484baa2011-01-05 16:28:43 -08002334}
2335
2336# Read the file that maps relative names to absolute names for
2337# separate source and object directories and for shadow trees.
2338if (open(SOURCE_MAP, "<.tmp_filelist.txt")) {
2339 my ($relname, $absname);
2340 while(<SOURCE_MAP>) {
2341 chop();
2342 ($relname, $absname) = (split())[0..1];
2343 $relname =~ s:^/+::;
2344 $source_map{$relname} = $absname;
2345 }
2346 close(SOURCE_MAP);
2347}
2348
Jani Nikula88c2b572016-06-07 11:00:52 +03002349if ($output_selection == OUTPUT_EXPORTED ||
2350 $output_selection == OUTPUT_INTERNAL) {
Jani Nikulac9b2cfb2016-06-07 11:05:53 +03002351
2352 push(@export_file_list, @ARGV);
2353
Jani Nikula88c2b572016-06-07 11:00:52 +03002354 foreach (@export_file_list) {
2355 chomp;
2356 process_export_file($_);
2357 }
2358}
2359
Randy Dunlap8484baa2011-01-05 16:28:43 -08002360foreach (@ARGV) {
2361 chomp;
2362 process_file($_);
2363}
2364if ($verbose && $errors) {
2365 print STDERR "$errors errors\n";
2366}
2367if ($verbose && $warnings) {
2368 print STDERR "$warnings warnings\n";
2369}
2370
Pierre-Louis Bossart2c12c812020-07-28 11:20:40 -05002371if ($Werror && $warnings) {
2372 print STDERR "$warnings warnings as Errors\n";
2373 exit($warnings);
2374} else {
2375 exit($output_mode eq "none" ? 0 : $errors)
2376}
Tomasz Warniełło2875f782022-02-18 19:16:21 +01002377
2378__END__
2379
2380=head1 OPTIONS
2381
2382=head2 Output format selection (mutually exclusive):
2383
2384=over 8
2385
2386=item -man
2387
2388Output troff manual page format.
2389
2390=item -rst
2391
2392Output reStructuredText format. This is the default.
2393
2394=item -none
2395
2396Do not output documentation, only warnings.
2397
2398=back
2399
Tomasz Warniełłodd803b02022-02-18 19:16:22 +01002400=head2 Output format modifiers
2401
2402=head3 reStructuredText only
2403
2404=over 8
2405
2406=item -sphinx-version VERSION
2407
2408Use the ReST C domain dialect compatible with a specific Sphinx Version.
2409
2410If not specified, kernel-doc will auto-detect using the sphinx-build version
2411found on PATH.
2412
2413=back
2414
Tomasz Warniełło9c77f102022-02-18 19:16:23 +01002415=head2 Output selection (mutually exclusive):
2416
2417=over 8
2418
2419=item -export
2420
2421Only output documentation for the symbols that have been exported using
2422EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE.
2423
2424=item -internal
2425
2426Only output documentation for the symbols that have NOT been exported using
2427EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() in any input FILE or -export-file FILE.
2428
2429=item -function NAME
2430
2431Only output documentation for the given function or DOC: section title.
2432All other functions and DOC: sections are ignored.
2433
2434May be specified multiple times.
2435
2436=item -nosymbol NAME
2437
2438Exclude the specified symbol from the output documentation.
2439
2440May be specified multiple times.
2441
2442=back
2443
Tomasz Warniełłoc15de5a2022-02-18 19:16:24 +01002444=head2 Output selection modifiers:
2445
2446=over 8
2447
2448=item -no-doc-sections
2449
2450Do not output DOC: sections.
2451
2452=item -export-file FILE
2453
2454Specify an additional FILE in which to look for EXPORT_SYMBOL() and
2455EXPORT_SYMBOL_GPL().
2456
2457To be used with -export or -internal.
2458
2459May be specified multiple times.
2460
2461=back
2462
2463=head3 reStructuredText only
2464
2465=over 8
2466
2467=item -enable-lineno
2468
Mauro Carvalho Chehabb79dfef2022-03-26 11:27:24 +01002469Enable output of .. LINENO lines.
Tomasz Warniełłoc15de5a2022-02-18 19:16:24 +01002470
2471=back
2472
Tomasz Warniełło834cf6b2022-02-18 19:16:25 +01002473=head2 Other parameters:
2474
2475=over 8
2476
2477=item -h, -help
2478
2479Print this help.
2480
2481=item -v
2482
2483Verbose output, more warnings and other information.
2484
2485=item -Werror
2486
2487Treat warnings as errors.
2488
2489=back
2490
Tomasz Warniełło2875f782022-02-18 19:16:21 +01002491=cut