From nobody Sun Feb 8 15:46:02 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id AA9F320010C; Mon, 12 Jan 2026 15:08:07 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768230487; cv=none; b=YToR5LAD4gG5qYLCi9dBUXjhMUtmeDzwP9qEVI8eFW0gbOqEc6khcZyZ3+gcCgQpiGI/KZVqPiYGFb3hTBtNzdRhfL33VP+3iNLgEvBw0wCEhUe8KzGBo0zCcAmdLN9zhD7KGlsDD1QYL7c+TTsOgjrIRVX9JUa1NS/57j6eVCg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768230487; c=relaxed/simple; bh=hQU7ILU8FGfaXvaPKyg+910Nis+bE1Jn3QGzXcDLK6c=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=ryihij1y9TT5kxrkbU9MG4B0li81wgP4nyI4eSqGUPgolMcdlATYqe2BXXTTTGogrG4RWj5K3bE1Uqs7XR5StoT2TT5yUQg0Ud1UL2D5BUkbuZkmT8eUpYKaObfP8N6sVJafBSZOLZfNEKq8dl4o2ewvgv8mtvSkXfoktqJM75Q= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=jRrIoLMC; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="jRrIoLMC" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 8B899C2BC87; Mon, 12 Jan 2026 15:08:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1768230487; bh=hQU7ILU8FGfaXvaPKyg+910Nis+bE1Jn3QGzXcDLK6c=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=jRrIoLMCKVWEGF9ZRLav5Ao9MtRvcKlYYwVveu0mddM32Fx/HVZqU6n5jq9X51qIU GJUBXOAIDaUj718bGbXEBT2rPwGmJQTZAJWb7NNq7Hmrn5/ttGvTg3lZcPKYpZ4Inh b1KtlH7Kt15I5Av2Pq09Aum3hv0G9cJTQNZC4uuZyKAVB/giA+a6gIR+2a/GckPJS1 W3eZOXZpfc8OONHx9YouLECadzlHciS21hfz35CBf+fYi2h4ce46hdWrakjgqx639+ j5l8GloXnqTUtb1n0DLdlDWDgVAwprp/0NTZw4+ezVsY4Uxq1o2uvOQOACOPMExZ/A ZgL0YDlHIwisw== Received: from mchehab by mail.kernel.org with local (Exim 4.99) (envelope-from ) id 1vfJWX-00000000JWy-39ts; Mon, 12 Jan 2026 16:08:05 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jani Nikula , Mauro Carvalho Chehab Subject: [PATCH v2 4/4] scripts/kernel-doc: some fixes to kernel-doc comments Date: Mon, 12 Jan 2026 16:06:53 +0100 Message-ID: <1ea812db44c941dcbdead57cd34ccd807261c436.1768229902.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.52.0 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab There are some typos and English errors at the kernel-doc.py comments. Locate them with the help of LLM (gpt-oss 14B), locally excecuted with this prompt: review English grammar andsyntax at the comments on the code below: Not all results are flowers, although it caught several minor issues there. Add the pertinent fixes, discarding the bad ones. Signed-off-by: Mauro Carvalho Chehab --- scripts/kernel-doc.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py index 7ccee4626478..28ec5500f664 100755 --- a/scripts/kernel-doc.py +++ b/scripts/kernel-doc.py @@ -9,10 +9,10 @@ # The rationale is that it shall fail gracefully during Kernel # compilation with older Kernel versions. Due to that: # - encoding line is needed here; -# - no f-strings can be used on this file. -# - the libraries that require newer versions can only be included -# after Python version is checked. - +# - f-strings cannot be used in this file. +# - libraries that require newer versions can only be included +# after the Python version has been checked. +# # Converted from the kernel-doc script originally written in Perl # under GPLv2, copyrighted since 1998 by the following authors: # @@ -134,13 +134,13 @@ May be used multiple times. """ =20 EXPORT_DESC =3D """ -Only output documentation for the symbols that have been +Only output documentation for symbols that have been exported using EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. """ =20 INTERNAL_DESC =3D """ -Only output documentation for the symbols that have NOT been +Only output documentation for symbols that have NOT been exported using EXPORT_SYMBOL() and related macros in any input FILE or -export-file FILE. """ @@ -163,7 +163,7 @@ Header and C source files to be parsed. """ =20 WARN_CONTENTS_BEFORE_SECTIONS_DESC =3D """ -Warns if there are contents before sections (deprecated). +Warn if there are contents before sections (deprecated). =20 This option is kept just for backward-compatibility, but it does nothing, neither here nor at the original Perl script. @@ -171,7 +171,7 @@ neither here nor at the original Perl script. =20 =20 class MsgFormatter(logging.Formatter): - """Helper class to format warnings on a similar way to kernel-doc.pl""" + """Helper class to format warnings in a similar way to kernel-doc.pl."= "" =20 def format(self, record): record.levelname =3D record.levelname.capitalize() @@ -277,7 +277,7 @@ def main(): help=3DNOSYMBOL_DESC) =20 parser.add_argument("-D", "-no-doc-sections", "--no-doc-sections", - action=3D'store_true', help=3D"Don't outputt DOC s= ections") + action=3D'store_true', help=3D"Don't output DOC se= ctions") =20 parser.add_argument("files", metavar=3D"FILE", nargs=3D"+", help=3DFILES_DESC) @@ -306,12 +306,12 @@ def main(): python_ver =3D sys.version_info[:2] if python_ver < (3,6): # - # Depending on Kernel configuration, kernel-doc --none is called at + # Depending on the Kernel configuration, kernel-doc --none is call= ed at # build time. As we don't want to break compilation due to the # usage of an old Python version, return 0 here. # if args.none: - logger.error("Python 3.6 or later is required by kernel-doc. s= kipping checks") + logger.error("Python 3.6 or later is required by kernel-doc. S= kipping checks") sys.exit(0) =20 sys.exit("Python 3.6 or later is required by kernel-doc. Aborting.= ") @@ -320,7 +320,7 @@ def main(): logger.warning("Python 3.7 or later is required for correct result= s") =20 # - # Import kernel-doc libraries only after checking Python version + # Import kernel-doc libraries only after checking the Python version # from kdoc.kdoc_files import KernelFiles # pylint: disable= =3DC0415 from kdoc.kdoc_output import RestFormat, ManFormat # pylint: disable= =3DC0415 --=20 2.52.0