Report warnings to the file they belong
Subsystems (2)
PATCH 1/2 get_abi.pl: Allow optionally record from where a line came from
In reply to Mauro Carvalho ChehabThe get_abi.pl reads a lot of files and can join them on a single output file. Store where each "What:" output came from, in order to be able to optionally display it.
This is useful for the Sphinx extension, with can now be able to blame what ABI file has issues, and on what line the What: description with problems begin.
--- scripts/get_abi.pl | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-)
scripts/get_abi.pl +20 -1
@@ -10,6 +10,7 @@ use Fcntl ':mode'; my $help; my $man; my $debug; +my $enable_lineno; my $prefix="Documentation/ABI"; #
@@ -19,6 +20,7 @@ my $description_is_rst = 0; GetOptions( "debug|d+" => \$debug, + "enable-lineno" => \$enable_lineno, "rst-source!" => \$description_is_rst, "dir=s" => \$prefix, 'help|?' => \$help,
@@ -134,6 +136,8 @@ sub parse_abi { if ($tag ne "" && $new_tag) { $tag = $new_tag; + $data{$what}->{line_no} = $ln; + if ($new_what) { @{$data{$what}->{label}} = @labels if ($data{$nametag}->{what}); @labels = ();
@@ -229,6 +233,12 @@ sub output_rest { my $file = $data{$what}->{file}; my $filepath = $data{$what}->{filepath}; + if ($enable_lineno) { + printf "#define LINENO %s%s#%s\n\n", + $prefix, $data{$what}->{file}, + $data{$what}->{line_no}; + } + my $w = $what; $w =~ s/([\(\)\_\-\*\=\^\~\\])/\\$1/g;
@@ -377,6 +387,10 @@ sub search_symbols { } } +# Ensure that the prefix will always end with a slash +# While this is not needed for find, it makes the patch nicer +# with --enable-lineno +$prefix =~ s,/?$,/,; # # Parses all ABI files located at $prefix dir
@@ -403,7 +417,8 @@ abi_book.pl - parse the Linux ABI files and produce a ReST book. =head1 SYNOPSIS -B<abi_book.pl> [--debug] [--man] [--help] --[(no-)rst-source] [--dir=<dir>] <COMAND> [<ARGUMENT>] +B<abi_book.pl> [--debug] [--enable-lineno] [--man] [--help] + [--(no-)rst-source] [--dir=<dir>] <COMAND> [<ARGUMENT>] Where <COMMAND> can be:
@@ -433,6 +448,10 @@ selecting between a rst-compliant source ABI (--rst-source), or a plain text that may be violating ReST spec, so it requres some escaping logic (--no-rst-source). +=item B<--enable-lineno> + +Enable output of #define LINENO lines. + =item B<--debug> Put the script in verbose mode, useful for debugging. Can be called multiple
Signature · 1 line
2.21.0
PATCH 2/2 docs: kernel_abi.py: use --enable-lineno for get_abi.pl
In reply to Mauro Carvalho ChehabJust like kernel-doc extension, we need to be able to identify what part of an imported document has issues, as reporting them as:
get_abi.pl rest --dir $srctree/Documentation/ABI/obsolete --rst-source:1689: ERROR: Unexpected indentation.
Makes a lot harder for someone to fix.
It should be noticed that it the line which will be reported is the line where the "What:" definition is, and not the line with actually has an error.
--- Documentation/sphinx/kernel_abi.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-)
Documentation/sphinx/kernel_abi.py +14 -4
@@ -35,6 +35,7 @@ import codecs import os import subprocess import sys +import re from os import path
@@ -93,7 +94,7 @@ class KernelCmd(Directive): env = doc.settings.env cwd = path.dirname(doc.current_source) - cmd = "get_abi.pl rest --dir " + cmd = "get_abi.pl rest --enable-lineno --dir " cmd += self.arguments[0]
@@ -141,7 +142,7 @@ class KernelCmd(Directive): % (self.name, ErrorString(exc))) return out - def nestedParse(self, lines, fname): + def nestedParse(self, lines, f): content = ViewList() node = nodes.section()
@@ -151,8 +152,17 @@ class KernelCmd(Directive): code_block += "\n " + l lines = code_block + "\n\n" - for c, l in enumerate(lines.split("\n")): - content.append(l, fname, c) + line_regex = re.compile("^#define LINENO (\S+)\#([0-9]+)$") + ln = 0 + + for line in lines.split("\n"): + match = line_regex.search(line) + if match: + f = match.group(1) + # sphinx counts lines from 0 + ln = int(match.group(2)) - 1 + else: + content.append(line, f, ln) buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter
Signature · 1 line
2.21.0
cover Report warnings to the file they belong
Reporting an ABI error to the get_abi.pl script is not nice, as it doesn't maky any easy to fix it.
Instead, just like with kernel-doc, put the fingers to the files that didn't parse ok:
Documentation/ABI/testing/sysfs-kernel-mm-hugepages:3: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/ABI/testing/evm:4: ERROR: Unexpected indentation.
Documentation/ABI/testing/evm:3: WARNING: Block quote ends without a blank line; unexpected unindent.
---
Greg,
Independently of the RFC patches, I would apply those two ones together with the script, as they make a lot easier to debug issues.
Mauro Carvalho Chehab (2):
get_abi.pl: Allow optionally record from where a line came from
docs: kernel_abi.py: use --enable-lineno for get_abi.pl
Documentation/sphinx/kernel_abi.py | 18 ++++++++++++++---- scripts/get_abi.pl | 21 ++++++++++++++++++++- 2 files changed, 34 insertions(+), 5 deletions(-)
Signature · 1 line
2.21.0