| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <cad306720aa8a4e86df8b8d584aa03462b791bac.1740387599.git.mchehab+huawei@kernel.org>
Date: Mon, 24 Feb 2025 10:08:41 +0100
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>,
Jonathan Corbet <corbet@....net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
"Mauro Carvalho Chehab" <mchehab+huawei@...nel.org>,
linux-kernel@...r.kernel.org
Subject: [PATCH v2 35/39] scripts/kernel-doc.py: some coding style cleanups
Remove some warnings generated by pylint. Among them, cleanup
TODO messages, removing the ones that were already handled,
as now all TODOs that are required to be fully compatible with
kernel-doc were already addressed.
So, the existing TODOs are pointing possible future cleanups and
improvements.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
---
scripts/kernel-doc.py | 10 +++++-----
scripts/lib/kdoc/kdoc_files.py | 1 -
scripts/lib/kdoc/kdoc_output.py | 1 +
scripts/lib/kdoc/kdoc_parser.py | 30 +++++++-----------------------
scripts/lib/kdoc/kdoc_re.py | 3 ++-
5 files changed, 15 insertions(+), 30 deletions(-)
diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py
index 7683fb4ffc59..5e1e1839438c 100755
--- a/scripts/kernel-doc.py
+++ b/scripts/kernel-doc.py
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
-# pylint: disable=C0103,
+# pylint: disable=C0103,R0915
# Copyright(c) 2025: Mauro Carvalho Chehab <mchehab@...nel.org>.
# SPDX-License-Identifier: GPL-2.0
@@ -167,7 +167,7 @@ def main():
# Those are valid for all 3 types of filter
parser.add_argument("-n", "-nosymbol", "--nosymbol", action='append',
- help=NOSYMBOL_DESC)
+ help=NOSYMBOL_DESC)
parser.add_argument("-D", "-no-doc-sections", "--no-doc-sections",
action='store_true', help="Don't outputt DOC sections")
@@ -211,9 +211,9 @@ def main():
kfiles.parse(args.files, export_file=args.export_file)
for t in kfiles.msg(enable_lineno=args.enable_lineno, export=args.export,
- internal=args.internal, symbol=args.symbol,
- nosymbol=args.nosymbol,
- no_doc_sections=args.no_doc_sections):
+ internal=args.internal, symbol=args.symbol,
+ nosymbol=args.nosymbol,
+ no_doc_sections=args.no_doc_sections):
msg = t[1]
if msg:
print(msg)
diff --git a/scripts/lib/kdoc/kdoc_files.py b/scripts/lib/kdoc/kdoc_files.py
index e130e5e32806..fc14bd6f9863 100755
--- a/scripts/lib/kdoc/kdoc_files.py
+++ b/scripts/lib/kdoc/kdoc_files.py
@@ -11,7 +11,6 @@ import argparse
import logging
import os
import re
-import sys
from kdoc_parser import KernelDoc
from kdoc_output import OutputFormat
diff --git a/scripts/lib/kdoc/kdoc_output.py b/scripts/lib/kdoc/kdoc_output.py
index d0cb7f511f87..487068753b53 100755
--- a/scripts/lib/kdoc/kdoc_output.py
+++ b/scripts/lib/kdoc/kdoc_output.py
@@ -234,6 +234,7 @@ class OutputFormat:
def out_struct(self, fname, name, args):
"""Outputs a struct"""
+
class RestFormat(OutputFormat):
"""Consts and functions used by ReST output"""
diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser.py
index 6cebc32e18f2..cf4bf7cedcbc 100755
--- a/scripts/lib/kdoc/kdoc_parser.py
+++ b/scripts/lib/kdoc/kdoc_parser.py
@@ -130,7 +130,7 @@ class KernelDoc:
# Place all potential outputs into an array
self.entries = []
- # TODO: rename to emit_message
+ # TODO: rename to emit_message after removal of kernel-doc.pl
def emit_warning(self, ln, msg, warning=True):
"""Emit a message"""
@@ -157,19 +157,6 @@ class KernelDoc:
name = self.entry.section
contents = self.entry.contents
- # TODO: we can prevent dumping empty sections here with:
- #
- # if self.entry.contents.strip("\n"):
- # if start_new:
- # self.entry.section = self.section_default
- # self.entry.contents = ""
- #
- # return
- #
- # But, as we want to be producing the same output of the
- # venerable kernel-doc Perl tool, let's just output everything,
- # at least for now
-
if type_param.match(name):
name = type_param.group(1)
@@ -205,7 +192,7 @@ class KernelDoc:
self.entry.section = self.section_default
self.entry.contents = ""
- # TODO: rename it to store_declaration
+ # TODO: rename it to store_declaration after removal of kernel-doc.pl
def output_declaration(self, dtype, name, **args):
"""
Stores the entry into an entry array.
@@ -225,13 +212,13 @@ class KernelDoc:
args["type"] = dtype
args["warnings"] = self.entry.warnings
- # TODO: use colletions.OrderedDict
+ # TODO: use colletions.OrderedDict to remove sectionlist
sections = args.get('sections', {})
sectionlist = args.get('sectionlist', [])
# Drop empty sections
- # TODO: improve it to emit warnings
+ # TODO: improve empty sections logic to emit warnings
for section in ["Description", "Return"]:
if section in sectionlist:
if not sections[section].rstrip():
@@ -635,7 +622,9 @@ class KernelDoc:
# Replace macros
#
- # TODO: it is better to also move those to the NestedMatch logic,
+ # TODO: use NestedMatch for FOO($1, $2, ...) matches
+ #
+ # it is better to also move those to the NestedMatch logic,
# to ensure that parenthesis will be properly matched.
(Re(r'__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)', re.S), r'DECLARE_BITMAP(\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'),
@@ -902,7 +891,6 @@ class KernelDoc:
self.dump_struct(ln, prototype)
return
- # TODO: handle other types
self.output_declaration(self.entry.decl_type, prototype,
entry=self.entry)
@@ -1670,10 +1658,6 @@ class KernelDoc:
self.st_inline_name[self.inline_doc_state],
line)
- # TODO: not all states allow EXPORT_SYMBOL*, so this
- # can be optimized later on to speedup parsing
- self.process_export(self.config.function_table, line)
-
# Hand this line to the appropriate state handler
if self.state == self.STATE_NORMAL:
self.process_normal(ln, line)
diff --git a/scripts/lib/kdoc/kdoc_re.py b/scripts/lib/kdoc/kdoc_re.py
index 45ddba8090e5..de362ec38db7 100755
--- a/scripts/lib/kdoc/kdoc_re.py
+++ b/scripts/lib/kdoc/kdoc_re.py
@@ -131,7 +131,8 @@ class NestedMatch:
will ignore the search string.
"""
- # TODO:
+ # TODO: make NestedMatch handle multiple match groups
+ #
# Right now, regular expressions to match it are defined only up to
# the start delimiter, e.g.:
#
--
2.48.1
Powered by blists - more mailing lists