From nobody Wed Feb 11 10:48:39 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 49EDB356A23; Mon, 12 Jan 2026 11:23:56 +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=1768217036; cv=none; b=XB+ltxQqqsj7pVjv8JGa+yJXL4yjXbpW81rYg5kjYTK2whcLtRTfGCgRisF9E2e4YClzrgOBwSFRLPjThz0YLwLMx+HQGoj3rynsOzvD8k3NgMLPx4LF5eWajRU0LvZLCvt/NzYVAUWNgBe50Su/R+qsvUBd3keb5HssGLFJidI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1768217036; c=relaxed/simple; bh=lGP3YEIb7htsUIa6dUl9swOOUdUMERQ+4bISrWtBkd0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=snKAEhDujQ8CSwuXQBcj2Wbg0iuANf0OTUKnA/fSYn8/rUBc7vthpiFs6fimBSzfMX1UauhXtth6KS61odBPUHWYjnVMr7WirJHVIsUn69PLRp+bXbBrehIVw5m7WWsptJwHt8ZAIdnTRGMl05KZgFNLODBQBXmIDJKzcJeKEpY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=NoLEE09u; 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="NoLEE09u" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 08851C16AAE; Mon, 12 Jan 2026 11:23:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1768217036; bh=lGP3YEIb7htsUIa6dUl9swOOUdUMERQ+4bISrWtBkd0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=NoLEE09uLOySikVTg45OD9Um6kIeH++3YOMbBoFLiq71ctPhuDWBEFfjHBp6bKQLC GrSMSCQvHv3q5vQuYWnnWQVO1RUx1iSW3+gg1flOa3LEszlgtHYOMwJPEvICE4YbXo KSlTacvfzR1164ynSCT9NV/7D6XLeuDVwh6OjW5yC+NaBEyFTPDsIzYuUkr3g67Aue nT+TjxomTSxndDzuIMylAXalyEUUy3UGd+tcc3Z41VTkVrBZ7igjHc/DEqX47pyGkO tjNMKYZSdz29lUE0i/86z6rhGQNAaOR6IqjuGx7li8jNrQpZhSsCYjlM4DIyPZUaW8 exGXwDa8M+f0g== Received: from mchehab by mail.kernel.org with local (Exim 4.99) (envelope-from ) id 1vfG1a-00000000DTq-0zhi; Mon, 12 Jan 2026 12:23:54 +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 3/4] scripts/kernel-doc: ensure that comments are using our coding style Date: Mon, 12 Jan 2026 12:23:25 +0100 Message-ID: <8dab4a0fff5b7054f45965e6289a7541a2a72c10.1768216455.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 600bdfea6a96..bcb60136fc9c 100755 --- a/scripts/kernel-doc.py +++ b/scripts/kernel-doc.py @@ -188,7 +188,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.") @@ -204,7 +206,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.") @@ -226,7 +230,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 @@ -239,7 +245,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() @@ -253,7 +261,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 @@ -286,9 +296,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) @@ -298,7 +310,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(): sys.exit(error_count) sys.exit(0) =20 +# # Call main method +# if __name__ =3D=3D "__main__": main() --=20 2.52.0