From nobody Sun Feb 8 18:33:18 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 C785E2DCBE6; 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=tDTC+fORw9W8JYL5Ib3o2YT/hcyAFLH6yFe9JCyRjmUwbMkppABtXAAX0sRAP2977vlOTwf4GBkQvxC2/ezf6gren3OwCA4eb+neCSQvHQRE8TTO6x+KlwQwRCzaQtLJxSD5Ak8WfCNvsPWy2fcvYOMDgvAB0frCYnyg9hHpwo0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768230487; c=relaxed/simple; bh=XChoitCpPvUu9DSulv7Knff2zjJ8XDFrF6Ndhe2QeNw=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=SoF30QNr3zHNg4LqlLrgQPVzGxh83nDU4u4iKvZioXgQNPXG2r0iLlmKd0WhNwFEdaab6qSSJ8eVdLBHQo+xvwyb6pgpuWp5E0Dp1he+/Ajfb2EVB26jMcs4gezAy29VycQq5kzwNZp+2WdO2Z5ogTe8DtmHVY4M/HOoUUn3zJw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=O3BL1tfo; 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="O3BL1tfo" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 6E6B4C19422; 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=XChoitCpPvUu9DSulv7Knff2zjJ8XDFrF6Ndhe2QeNw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=O3BL1tfosJBTJkj45T+uShqe850nExpFMwx55OTNtl7GRdFzFwvoX7WU8XjH63qHN aW/FF5ijAyeqvI30kegPbFsxmlzoaG+jg6z7JhN1wZq0vJpDkTjzPmwPvp9MfRSrEH 6n4myo5l+LxUbc0oU6fe46N3jwkV7FREQQeDo4JpMCquUrQ0j89sBE1bzsv+PU86gA dTXVK9sH0BfXlUR1iPujT9LtQZEunj/tlRqVNqYeyl/u5yeWxX2dBezqG9wMbHNH3z FiOEqOuIWvEg1YFZu38GsiG6Eu5AxZsl8YC2Of1I/P6Zai5VMLPq9xhtmSUPOJHGzq 0K5IGt9nQp6gw== Received: from mchehab by mail.kernel.org with local (Exim 4.99) (envelope-from ) id 1vfJWX-00000000JWu-32zi; Mon, 12 Jan 2026 16:08:05 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Mauro Carvalho Chehab Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jani Nikula , Jonathan Corbet Subject: [PATCH v2 3/4] scripts/kernel-doc: ensure that comments are using our coding style Date: Mon, 12 Jan 2026 16:06:52 +0100 Message-ID: <7604a45e8ade06994afeb68616cf1838dd1101ec.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 Along kernel-doc libs, we opted to have all comments starting/ending with a blank comment line. Use the same style here. Signed-off-by: Mauro Carvalho Chehab --- scripts/kernel-doc.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/scripts/kernel-doc.py b/scripts/kernel-doc.py index 5d2f29e90ebe..7ccee4626478 100755 --- a/scripts/kernel-doc.py +++ b/scripts/kernel-doc.py @@ -197,7 +197,9 @@ def main(): parser =3D argparse.ArgumentParser(formatter_class=3Dargparse.RawTextH= elpFormatter, description=3DDESC) =20 + # # Normal arguments + # =20 parser.add_argument("-v", "-verbose", "--verbose", action=3D"store_tru= e", help=3D"Verbose output, more warnings and other in= formation.") @@ -213,7 +215,9 @@ def main(): action=3D"store_true", help=3D"Enable line number output (only in ReST mo= de)") =20 + # # Arguments to control the warning behavior + # =20 parser.add_argument("-Wreturn", "--wreturn", action=3D"store_true", help=3D"Warns about the lack of a return markup on= functions.") @@ -235,7 +239,9 @@ def main(): parser.add_argument("-export-file", "--export-file", action=3D'append', help=3DEXPORT_FILE_DESC) =20 + # # Output format mutually-exclusive group + # =20 out_group =3D parser.add_argument_group("Output format selection (mutu= ally exclusive)") =20 @@ -248,7 +254,9 @@ def main(): out_fmt.add_argument("-N", "-none", "--none", action=3D"store_true", help=3D"Do not output documentation, only warning= s.") =20 + # # Output selection mutually-exclusive group + # =20 sel_group =3D parser.add_argument_group("Output selection (mutually ex= clusive)") sel_mut =3D sel_group.add_mutually_exclusive_group() @@ -262,7 +270,9 @@ def main(): sel_mut.add_argument("-s", "-function", "--symbol", action=3D'append', help=3DFUNCTION_DESC) =20 + # # Those are valid for all 3 types of filter + # parser.add_argument("-n", "-nosymbol", "--nosymbol", action=3D'append', help=3DNOSYMBOL_DESC) =20 @@ -295,9 +305,11 @@ def main(): =20 python_ver =3D sys.version_info[:2] if python_ver < (3,6): + # # Depending on Kernel configuration, kernel-doc --none is called 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") sys.exit(0) @@ -307,7 +319,9 @@ def main(): if python_ver < (3,7): logger.warning("Python 3.7 or later is required for correct result= s") =20 + # # Import kernel-doc libraries only after checking Python version + # from kdoc.kdoc_files import KernelFiles # pylint: disable= =3DC0415 from kdoc.kdoc_output import RestFormat, ManFormat # pylint: disable= =3DC0415 =20 @@ -346,6 +360,8 @@ def main(): =20 sys.exit(0) =20 +# # Call main method +# if __name__ =3D=3D "__main__": main() --=20 2.52.0