From nobody Sun Dec 14 01:39:26 2025 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 B44B31E9B02; Tue, 11 Feb 2025 06:19:37 +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=1739254777; cv=none; b=XfIPpizTNREBcgWPV/JeQpEaGyFlycHXR0fDk5xfpoz4P63oVFBgu9o3YmhsRPx1Adt7Gd/C1DgafaJT9V79AdDcKt/L5AR4gRlCSkOKPbK+4QquzKjznpbexa7PWXCJu9o/2QNyh2KDeayoDay/Lwjp7/xYiNRlp8BAbD2FmsA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739254777; c=relaxed/simple; bh=SyM5UIEo4uAp+xqe9mn1VaTXcvRSgbtPGvMeBSM6HzE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=GLH/i14W6qvzE2pRul6pGZSeHefVaZfktvbaBrdJqMkCGfW2ag9QWd0eAP/WpOpgtD9eGTFOaAnxyeqaK1YzCUeSdM7UZtODJ/fTf0TKBOzj7Wnqf/NmozHxfVX1MFiXJHqzYNdUmc7orhEa6CKN3usbWHcfALoghfECxq5QOK4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=tzecbrUB; 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="tzecbrUB" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3F0F2C4CEDD; Tue, 11 Feb 2025 06:19:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1739254777; bh=SyM5UIEo4uAp+xqe9mn1VaTXcvRSgbtPGvMeBSM6HzE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=tzecbrUBWZxWH06htlbP4f+1gzg1FJcpR9BFDkC2SkywUCW7gNWqwnMd3A6EzAADS D2ZdoiujeXpuhzHa/yq6SPE7uZ4bHVBti7+kB925KuFhotBD2ZVebNyASxf9jsE0OF X3I/St8u9IQRQNL680kOcN6xRdoACq0yKO3G7WGfQLqzhWU/PIy73A8mVjFeKfCdb7 /EN3Es1Z3T2nq5G6/NwDHILjLczdxD7ij2fYPf912wlk9vv/OQ1cTHQLStkzNWA0Ul hJNONdddoVlgAl1C1FZSIxD8PawVUW2u3G5EvmNgM6CbknnFFS0/mltzNa+rGZUAka ri1I8WU/qJ6dQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1thjcN-00000008Y6X-15Jj; Tue, 11 Feb 2025 07:19:35 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , linux-kernel@vger.kernel.org, workflows@vger.kernel.org Subject: [PATCH 1/4] docs: changes: update Sphinx minimal version to 3.4.3 Date: Tue, 11 Feb 2025 07:19:01 +0100 Message-ID: X-Mailer: git-send-email 2.48.1 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-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" Doing that allows us to get rid of all backward-compatible code. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Kees Cook --- Documentation/conf.py | 2 +- Documentation/process/changes.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 0c2205d536b3..3dad1f90b098 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -47,7 +47,7 @@ from load_config import loadConfig # -- General configuration ------------------------------------------------ =20 # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx =3D '2.4.4' +needs_sphinx =3D '3.4.3' =20 # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom diff --git a/Documentation/process/changes.rst b/Documentation/process/chan= ges.rst index a0beca805362..66015c768cfc 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -58,7 +58,7 @@ mcelog 0.6 mcelog --version iptables 1.4.2 iptables -V openssl & libcrypto 1.0.0 openssl version bc 1.06.95 bc --version -Sphinx\ [#f1]_ 2.4.4 sphinx-build --version +Sphinx\ [#f1]_ 3.4.3 sphinx-build --version GNU tar 1.28 tar --version gtags (optional) 6.6.5 gtags --version mkimage (optional) 2017.01 mkimage --version --=20 2.48.1 From nobody Sun Dec 14 01:39:26 2025 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 B445B1E9B00; Tue, 11 Feb 2025 06:19:37 +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=1739254777; cv=none; b=SIfMmRWgZmd7kAdEsXzeqynrpIhtYoyNszPG0+wfr/srfZr9UV29UDbMJdt2jJb8ovIVIcy21oscFz4p/+qqzuBy9iAwMVpPpUVo5OncRLeWCEvhip7RCACQOj2cHFGs0T52iKxo90GfayBuf4vzbzv0N3HSO0zG7YV7ZrJRLVo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739254777; c=relaxed/simple; bh=T9NTAO1QRuFZX33xgmpknoyP3QWfqh1E9HVIBAeBXR8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=KdlqcFxYMR+anBihJ7j3gfQ7Kw4KR9ieAGe27SSTNEJO0KezK788ytRU24VN9tngCX1w2Q1iBdbEnSl5ClLoLlEky20q4Der9Ni45nMSTmGrFQi5u0E/anO2OImE2SrBoYv+b9+ffNP5iZGwQk7VCGoR1NxKaKFDkim+v6wPWNs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DdQPTYrR; 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="DdQPTYrR" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 38726C4CEE7; Tue, 11 Feb 2025 06:19:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1739254777; bh=T9NTAO1QRuFZX33xgmpknoyP3QWfqh1E9HVIBAeBXR8=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DdQPTYrR84kN7ksxe3PxP9pR7cF8RAgLe5OLQOpiTJvai6jcgfWeRV+F9Dp9+SA6Z eZGhM8I+57bK8+vhqXPCHL7du6TTaj8FGiCnM27eoNjorsHLgp2jtVUnddpdmOZ9a9 JdKPUIq4ZER7OFQi4wQzAFrtBcqDXiphzzl+5vuhJkkfSiOuDWSqN5cObJdMBs8EMk Dxqeb7+Imtacz6y2/gIYgT9Q9CkTtvgqUfzNKAsxlVoI3J1TB8DqKw/u5Qr6fZyMnl XYRPXXgtSSWXxt9f5EaDW2Dz3NpVbGBk3HCo1TX+c4s6YCmMwNh33D+l1vf4FIGt/r Q/G++N2+YAyeQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1thjcN-00000008Y6a-1D6m; Tue, 11 Feb 2025 07:19:35 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , Bill Wendling , Justin Stitt , Nathan Chancellor , Nick Desaulniers , bpf@vger.kernel.org, linux-kernel@vger.kernel.org, llvm@lists.linux.dev, workflows@vger.kernel.org Subject: [PATCH 2/4] docs: changes: update Python minimal version Date: Tue, 11 Feb 2025 07:19:02 +0100 Message-ID: <34dda7a5a75f30380d95d8e85a8813be98dc72fe.1739254187.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.48.1 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-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" The current minimal version doesn't match what we have currently at the Kernel: $ vermin -v $(git ls-files *.py) ... Minimum required versions: 3.10 Incompatible versions: 2 Those are the Python scripts requiring versions higher than current minimal= (3.5): !2, 3.10 tools/net/sunrpc/xdrgen/generators/__init__.py !2, 3.10 tools/net/sunrpc/xdrgen/generators/program.py !2, 3.10 tools/net/sunrpc/xdrgen/subcmds/source.py !2, 3.10 tools/net/sunrpc/xdrgen/xdr_ast.py !2, 3.10 tools/power/cpupower/bindings/python/test_raw_pylibcpu= power.py !2, 3.9 tools/testing/selftests/net/rds/test.py !2, 3.9 tools/net/ynl/ethtool.py !2, 3.9 tools/net/ynl/cli.py !2, 3.9 scripts/checktransupdate.py !2, 3.8 tools/testing/selftests/tc-testing/plugin-lib/nsPlugin= .py !2, 3.8 tools/testing/selftests/hid/tests/base.py !2, 3.7 tools/testing/selftests/turbostat/smi_aperf_mperf.py !2, 3.7 tools/testing/selftests/turbostat/defcolumns.py !2, 3.7 tools/testing/selftests/turbostat/added_perf_counters.= py !2, 3.7 tools/testing/selftests/hid/tests/conftest.py !2, 3.7 tools/testing/kunit/qemu_config.py !2, 3.7 tools/testing/kunit/kunit_tool_test.py !2, 3.7 tools/testing/kunit/kunit.py !2, 3.7 tools/testing/kunit/kunit_parser.py !2, 3.7 tools/testing/kunit/kunit_kernel.py !2, 3.7 tools/testing/kunit/kunit_json.py !2, 3.7 tools/testing/kunit/kunit_config.py !2, 3.7 tools/perf/scripts/python/gecko.py !2, 3.7 scripts/rust_is_available_test.py !2, 3.7 scripts/bpf_doc.py !2, 3.6 tools/writeback/wb_monitor.py !2, 3.6 tools/workqueue/wq_monitor.py !2, 3.6 tools/workqueue/wq_dump.py !2, 3.6 tools/usb/p9_fwd.py !2, 3.6 tools/tracing/rtla/sample/timerlat_load.py !2, 3.6 tools/testing/selftests/net/openvswitch/ovs-dpctl.py !2, 3.6 tools/testing/selftests/net/nl_netdev.py !2, 3.6 tools/testing/selftests/net/lib/py/ynl.py !2, 3.6 tools/testing/selftests/net/lib/py/utils.py !2, 3.6 tools/testing/selftests/net/lib/py/nsim.py !2, 3.6 tools/testing/selftests/net/lib/py/netns.py !2, 3.6 tools/testing/selftests/net/lib/py/ksft.py !2, 3.6 tools/testing/selftests/kselftest/ksft.py !2, 3.6 tools/testing/selftests/hid/tests/test_tablet.py !2, 3.6 tools/testing/selftests/hid/tests/test_sony.py !2, 3.6 tools/testing/selftests/hid/tests/test_multitouch.py !2, 3.6 tools/testing/selftests/hid/tests/test_mouse.py !2, 3.6 tools/testing/selftests/hid/tests/base_gamepad.py !2, 3.6 tools/testing/selftests/hid/tests/base_device.py !2, 3.6 tools/testing/selftests/drivers/net/stats.py !2, 3.6 tools/testing/selftests/drivers/net/shaper.py !2, 3.6 tools/testing/selftests/drivers/net/queues.py !2, 3.6 tools/testing/selftests/drivers/net/ping.py !2, 3.6 tools/testing/selftests/drivers/net/lib/py/remote_ssh.= py !2, 3.6 tools/testing/selftests/drivers/net/lib/py/load.py !2, 3.6 tools/testing/selftests/drivers/net/lib/py/__init__.py !2, 3.6 tools/testing/selftests/drivers/net/lib/py/env.py !2, 3.6 tools/testing/selftests/drivers/net/hw/rss_ctx.py !2, 3.6 tools/testing/selftests/drivers/net/hw/pp_alloc_fail.py !2, 3.6 tools/testing/selftests/drivers/net/hw/nic_performance= .py !2, 3.6 tools/testing/selftests/drivers/net/hw/nic_link_layer.= py !2, 3.6 tools/testing/selftests/drivers/net/hw/lib/py/linkconf= ig.py !2, 3.6 tools/testing/selftests/drivers/net/hw/lib/py/__init__= .py !2, 3.6 tools/testing/selftests/drivers/net/hw/devmem.py !2, 3.6 tools/testing/selftests/drivers/net/hw/devlink_port_sp= lit.py !2, 3.6 tools/testing/selftests/drivers/net/hw/csum.py !2, 3.6 tools/testing/selftests/devices/probe/test_discoverabl= e_devices.py !2, 3.6 tools/testing/selftests/bpf/test_bpftool_synctypes.py !2, 3.6 tools/testing/selftests/bpf/generate_udp_fragments.py !2, 3.6 tools/testing/kunit/run_checks.py !2, 3.6 tools/testing/kunit/kunit_printer.py !2, 3.6 tools/sched_ext/scx_show_state.py !2, 3.6 tools/perf/tests/shell/lib/perf_metric_validation.py !2, 3.6 tools/perf/tests/shell/lib/perf_json_output_lint.py !2, 3.6 tools/perf/scripts/python/parallel-perf.py !2, 3.6 tools/perf/scripts/python/flamegraph.py !2, 3.6 tools/perf/scripts/python/arm-cs-trace-disasm.py !2, 3.6 tools/perf/pmu-events/models.py !2, 3.6 tools/perf/pmu-events/metric_test.py !2, 3.6 tools/perf/pmu-events/metric.py !2, 3.6 tools/perf/pmu-events/jevents.py !2, 3.6 tools/net/ynl/ynl-gen-rst.py !2, 3.6 tools/net/ynl/ynl-gen-c.py !2, 3.6 tools/net/ynl/lib/ynl.py !2, 3.6 tools/net/ynl/lib/nlspec.py !2, 3.6 tools/crypto/tcrypt/tcrypt_speed_compare.py !2, 3.6 tools/cgroup/iocost_monitor.py !2, 3.6 tools/cgroup/iocost_coef_gen.py !2, 3.6 scripts/make_fit.py !2, 3.6 scripts/macro_checker.py !2, 3.6 scripts/get_abi.py !2, 3.6 scripts/generate_rust_analyzer.py !2, 3.6 scripts/gdb/linux/timerlist.py !2, 3.6 scripts/gdb/linux/pgtable.py !2, 3.6 scripts/clang-tools/run-clang-tools.py !2, 3.6 Documentation/sphinx/automarkup.py Even if we exclude tools/net/sunrpc/xdrgen/, the minimal version is Python 3.9. Update process/changes to reflect the current minimal version required to run Python scripts outside tools. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Kees Cook --- Documentation/process/changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/process/changes.rst b/Documentation/process/chan= ges.rst index 66015c768cfc..d564362773b5 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -62,7 +62,7 @@ Sphinx\ [#f1]_ 3.4.3 sphinx-build --ve= rsion GNU tar 1.28 tar --version gtags (optional) 6.6.5 gtags --version mkimage (optional) 2017.01 mkimage --version -Python (optional) 3.5.x python3 --version +Python (optional) 3.9.x python3 --version GNU AWK (optional) 5.1.0 gawk --version =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 --=20 2.48.1 From nobody Sun Dec 14 01:39:26 2025 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 C211B1E9B06; Tue, 11 Feb 2025 06:19:37 +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=1739254777; cv=none; b=nrgRgr28HdgpsyDzWFkEER8UEvuhNdxi0Xp3RyytPQPL4gSQPFltJDabD1bnsbRPL5mDCVrseJtPup0HMZJXOYtmnJtKdR59oe21cIOtE8Ojhsw6fz/+jWeQe1tXR2XEjxKlN8afPfMY2FAu8N5suKLwUdcZIw+OXE6TMa6o3lo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739254777; c=relaxed/simple; bh=p/Z2Ab/2lyYQoWXm0SaYttyW5aZICXXJG85lswoPWzo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ELyfpNd0ltzRxZJGWp1cEhH2ypCx9ygjG7FLAPGmwQW5Yyw266BNUiJNF5IE3NOmlbO0i16SY/yuZIVxtJPJwLr1Emzg8F2Afw4f4+LD9ZmgUEjIYR/Hg5bAIU+Dck/lTkl0r4UkS2TEphR3N4hWx94SqHP3wYxN+ZKySzy13r4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=DD9772i5; 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="DD9772i5" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 3CC26C4AF09; Tue, 11 Feb 2025 06:19:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1739254777; bh=p/Z2Ab/2lyYQoWXm0SaYttyW5aZICXXJG85lswoPWzo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DD9772i5e81KhyKNMc8XBSZXjBl5TVAk2U6RhD491ygXQaApAvsZq8rhla9j/ihRD 6JR4wlt5HhMn/STVYnD0ozwhKIkvjBiaziFpI2athuEsEpv+NKn8QoQJxIFfmUasYU /P9+L3iGfOBxbt92bggXDWVxE1tNNuFsWljdw3P3fQ/l8GEjDX1vocE885P/BQXeR/ m9GyWIxy+PihOKuEX0NZ1QGOMHz6ZYtchyToPw7XZi66cnfrNoSMA3j/EOOF8tb0ei N1FBmN8oO0fe0xbEcY2ailwmdv+prnHRK3zmCOkql1Tj6+mHeDLA+0SBuuBrxYEaRW Me6E76P0iE3XQ== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1thjcN-00000008Y6e-1KMf; Tue, 11 Feb 2025 07:19:35 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , Akira Yokosawa , Vegard Nossum , linux-kernel@vger.kernel.org Subject: [PATCH 3/4] docs: extensions: don't use utf-8 syntax for descriptions Date: Tue, 11 Feb 2025 07:19:03 +0100 Message-ID: <8a42f6be53464af4b866492a7e9ddf29c0429997.1739254187.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.48.1 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-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" None of the descriptions at the Sphinx extensions are using non-ascii characters, so no need to place them under u""" notation. Also, according with: https://docs.python.org/3/deprecations/pending-removal-in-3.16.html the 'u' format code is scheduled to be removed in Python 3.16. So, let's just use """. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Kees Cook --- Documentation/sphinx/cdomain.py | 4 ++-- Documentation/sphinx/kernel_abi.py | 6 +++--- Documentation/sphinx/kernel_feat.py | 4 ++-- Documentation/sphinx/kernel_include.py | 4 ++-- Documentation/sphinx/kfigure.py | 10 +++++----- Documentation/sphinx/load_config.py | 2 +- Documentation/sphinx/maintainers_include.py | 4 ++-- Documentation/sphinx/rstFlatTable.py | 10 +++++----- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/Documentation/sphinx/cdomain.py b/Documentation/sphinx/cdomain= .py index e6959af25402..6596fd00663f 100644 --- a/Documentation/sphinx/cdomain.py +++ b/Documentation/sphinx/cdomain.py @@ -1,6 +1,6 @@ # -*- coding: utf-8; mode: python -*- # pylint: disable=3DW0141,C0113,C0103,C0325 -u""" +""" cdomain ~~~~~~~ =20 @@ -145,7 +145,7 @@ class CObject(Base_CObject): } =20 def handle_func_like_macro(self, sig, signode): - u"""Handles signatures of function-like macros. + """Handles signatures of function-like macros. =20 If the objtype is 'function' and the signature ``sig`` is a function-like macro, the name of the macro is returned. Otherwise diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kern= el_abi.py index e017b0299953..db6f0380de94 100644 --- a/Documentation/sphinx/kernel_abi.py +++ b/Documentation/sphinx/kernel_abi.py @@ -2,7 +2,7 @@ # coding=3Dutf-8 # SPDX-License-Identifier: GPL-2.0 # -u""" +""" kernel-abi ~~~~~~~~~~ =20 @@ -55,7 +55,7 @@ path =3D os.path.join(srctree, "Documentation/ABI") _kernel_abi =3D None =20 def get_kernel_abi(): - u""" + """ Initialize kernel_abi global var, if not initialized yet. =20 This is needed to avoid warnings during Sphinx module initialization. @@ -81,7 +81,7 @@ def setup(app): =20 =20 class KernelCmd(Directive): - u"""KernelABI (``kernel-abi``) directive""" + """KernelABI (``kernel-abi``) directive""" =20 required_arguments =3D 1 optional_arguments =3D 3 diff --git a/Documentation/sphinx/kernel_feat.py b/Documentation/sphinx/ker= nel_feat.py index 03ace5f01b5c..e3a51867f27b 100644 --- a/Documentation/sphinx/kernel_feat.py +++ b/Documentation/sphinx/kernel_feat.py @@ -1,7 +1,7 @@ # coding=3Dutf-8 # SPDX-License-Identifier: GPL-2.0 # -u""" +""" kernel-feat ~~~~~~~~~~~ =20 @@ -56,7 +56,7 @@ def setup(app): =20 class KernelFeat(Directive): =20 - u"""KernelFeat (``kernel-feat``) directive""" + """KernelFeat (``kernel-feat``) directive""" =20 required_arguments =3D 1 optional_arguments =3D 2 diff --git a/Documentation/sphinx/kernel_include.py b/Documentation/sphinx/= kernel_include.py index 638762442336..8db176045bc5 100755 --- a/Documentation/sphinx/kernel_include.py +++ b/Documentation/sphinx/kernel_include.py @@ -2,7 +2,7 @@ # -*- coding: utf-8; mode: python -*- # pylint: disable=3DR0903, C0330, R0914, R0912, E0401 =20 -u""" +""" kernel-include ~~~~~~~~~~~~~~ =20 @@ -56,7 +56,7 @@ def setup(app): class KernelInclude(Include): # =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 - u"""KernelInclude (``kernel-include``) directive""" + """KernelInclude (``kernel-include``) directive""" =20 def run(self): env =3D self.state.document.settings.env diff --git a/Documentation/sphinx/kfigure.py b/Documentation/sphinx/kfigure= .py index 383f9a695b08..f1a7f13c9c60 100644 --- a/Documentation/sphinx/kfigure.py +++ b/Documentation/sphinx/kfigure.py @@ -1,6 +1,6 @@ # -*- coding: utf-8; mode: python -*- # pylint: disable=3DC0103, R0903, R0912, R0915 -u""" +""" scalable figure and image handling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 @@ -165,7 +165,7 @@ def setup(app): =20 =20 def setupTools(app): - u""" + """ Check available build tools and log some *verbose* messages. =20 This function is called once, when the builder is initiated. @@ -445,7 +445,7 @@ class kernel_image(nodes.image): pass =20 class KernelImage(images.Image): - u"""KernelImage directive + """KernelImage directive =20 Earns everything from ``.. image::`` directive, except *remote URI* and *glob* pattern. The KernelImage wraps a image node into a @@ -481,7 +481,7 @@ class kernel_figure(nodes.figure): """Node for ``kernel-figure`` directive.""" =20 class KernelFigure(Figure): - u"""KernelImage directive + """KernelImage directive =20 Earns everything from ``.. figure::`` directive, except *remote URI* a= nd *glob* pattern. The KernelFigure wraps a figure node into a kernel_fi= gure @@ -557,7 +557,7 @@ class kernel_render(nodes.General, nodes.Inline, nodes.= Element): pass =20 class KernelRender(Figure): - u"""KernelRender directive + """KernelRender directive =20 Render content by external tool. Has all the options known from the *figure* directive, plus option ``caption``. If ``caption`` has a diff --git a/Documentation/sphinx/load_config.py b/Documentation/sphinx/loa= d_config.py index 8b416bfd75ac..ec50e1ee5223 100644 --- a/Documentation/sphinx/load_config.py +++ b/Documentation/sphinx/load_config.py @@ -9,7 +9,7 @@ from sphinx.util.osutil import fs_encoding def loadConfig(namespace): # ------------------------------------------------------------------------= ------ =20 - u"""Load an additional configuration file into *namespace*. + """Load an additional configuration file into *namespace*. =20 The name of the configuration file is taken from the environment ``SPHINX_CONF``. The external configuration file extends (or overwrite= s) the diff --git a/Documentation/sphinx/maintainers_include.py b/Documentation/sp= hinx/maintainers_include.py index dcad0fff4723..d31cff867436 100755 --- a/Documentation/sphinx/maintainers_include.py +++ b/Documentation/sphinx/maintainers_include.py @@ -3,7 +3,7 @@ # -*- coding: utf-8; mode: python -*- # pylint: disable=3DR0903, C0330, R0914, R0912, E0401 =20 -u""" +""" maintainers-include ~~~~~~~~~~~~~~~~~~~ =20 @@ -37,7 +37,7 @@ def setup(app): ) =20 class MaintainersInclude(Include): - u"""MaintainersInclude (``maintainers-include``) directive""" + """MaintainersInclude (``maintainers-include``) directive""" required_arguments =3D 0 =20 def parse_maintainers(self, path): diff --git a/Documentation/sphinx/rstFlatTable.py b/Documentation/sphinx/rs= tFlatTable.py index 16bea0632555..180fbb50c337 100755 --- a/Documentation/sphinx/rstFlatTable.py +++ b/Documentation/sphinx/rstFlatTable.py @@ -2,7 +2,7 @@ # -*- coding: utf-8; mode: python -*- # pylint: disable=3DC0330, R0903, R0912 =20 -u""" +""" flat-table ~~~~~~~~~~ =20 @@ -99,7 +99,7 @@ class colSpan(nodes.General, nodes.Element): pass # pylin= t: disable=3DC0103,C0321 class FlatTable(Table): # =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 - u"""FlatTable (``flat-table``) directive""" + """FlatTable (``flat-table``) directive""" =20 option_spec =3D { 'name': directives.unchanged @@ -135,7 +135,7 @@ class FlatTable(Table): class ListTableBuilder(object): # =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 - u"""Builds a table from a double-stage list""" + """Builds a table from a double-stage list""" =20 def __init__(self, directive): self.directive =3D directive @@ -212,7 +212,7 @@ class ListTableBuilder(object): raise SystemMessagePropagation(error) =20 def parseFlatTableNode(self, node): - u"""parses the node from a :py:class:`FlatTable` directive's body"= "" + """parses the node from a :py:class:`FlatTable` directive's body""" =20 if len(node) !=3D 1 or not isinstance(node[0], nodes.bullet_list): self.raiseError( @@ -225,7 +225,7 @@ class ListTableBuilder(object): self.roundOffTableDefinition() =20 def roundOffTableDefinition(self): - u"""Round off the table definition. + """Round off the table definition. =20 This method rounds off the table definition in :py:member:`rows`. =20 --=20 2.48.1 From nobody Sun Dec 14 01:39:26 2025 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 B45131E9B03; Tue, 11 Feb 2025 06:19:37 +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=1739254777; cv=none; b=CKsMJGpMZeBry1OqJlEQQobHX2K0yVVK+3M7559m35sQabgFwQ4lNFhBshSHif9W4AZYdQllNUDvSOF9WR8HIvoiwRSNDE83DJfLawhEqZnD8gI3g54G7u0tPOmu2yF8m1arycbNdK+BsXcge8fhFKHoaVH2IB1NZFOZ303Gzpc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739254777; c=relaxed/simple; bh=fXjChbkoWttk6b9zeSDqzMhiiSdcMPZNU6a7c0viQdU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=A5U5rOasH3h8QsJKXV4c4/VZe6S8pxdC0AfFd+56ay3F9KKaR6ByLgMgB07JGnvEyn9r/U9QyY3QnxJPD/49arxUi4wsYbZt61080RkwYPrcMwJxcxVZH2jGJiAd62mEcvwsTiV84qIpBKMOr4LQeb1pd5wjhaBDk7PVp9a/E7E= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=QfYkE78e; 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="QfYkE78e" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 328B4C4CEE5; Tue, 11 Feb 2025 06:19:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1739254777; bh=fXjChbkoWttk6b9zeSDqzMhiiSdcMPZNU6a7c0viQdU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=QfYkE78eA/95JRsvfRtfwA6YvgcHiAeCcrPz7tJTvnQaEPBgGqz4iVekj6AW/sv9n 60Lx/LyvhDhRfOuai11AQVH50vWx0xQOhKmucA39BLARmsKN9W1RZxN/uoa7z2l/TO OI0TDitdorbWiFzVEbqHdl572Z3ZNkthrg8ZOluu+l+Ej5g+/Jf+3nl2dNXK+ybhIs 9h1sMXvJHg74qAsmsKAa6flLs2/FC7YrR6O1EH72U6exI4vz4KYGoWRrrwBks86yi+ SVreaPkMP6fhDBcXPUNH5CrPNJEnYjXSW5XOFlZpKMbWdJHmXnhjwpBjUBKe1kGNQV RWGuN2dotMeYg== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1thjcN-00000008Y6i-1RMX; Tue, 11 Feb 2025 07:19:35 +0100 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , Randy Dunlap , Vegard Nossum , linux-kernel@vger.kernel.org Subject: [PATCH 4/4] scripts/kernel-doc: drop Sphinx version check Date: Tue, 11 Feb 2025 07:19:04 +0100 Message-ID: <0d002e7550476a68547ee53ad06cfd8fdcaf7c3a.1739254187.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.48.1 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-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" As the current minimal supported Sphinx version is 3.4.3, drop support for older versions. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Kees Cook --- Documentation/sphinx/cdomain.py | 3 - Documentation/sphinx/kerneldoc.py | 5 -- scripts/kernel-doc | 129 ++++-------------------------- 3 files changed, 16 insertions(+), 121 deletions(-) diff --git a/Documentation/sphinx/cdomain.py b/Documentation/sphinx/cdomain= .py index 6596fd00663f..e8ea80d4324c 100644 --- a/Documentation/sphinx/cdomain.py +++ b/Documentation/sphinx/cdomain.py @@ -45,9 +45,6 @@ import re =20 __version__ =3D '1.1' =20 -# Get Sphinx version -major, minor, patch =3D sphinx.version_info[:3] - # Namespace to be prepended to the full name namespace =3D None =20 diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerne= ldoc.py index be5b8fbf373f..39ddae6ae7dd 100644 --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -62,11 +62,6 @@ class KernelDocDirective(Directive): env =3D self.state.document.settings.env cmd =3D [env.config.kerneldoc_bin, '-rst', '-enable-lineno'] =20 - # Pass the version string to kernel-doc, as it needs to use a diff= erent - # dialect, depending what the C domain supports for each specific - # Sphinx versions - cmd +=3D ['-sphinx-version', sphinx.__version__] - filename =3D env.config.kerneldoc_srctree + '/' + self.arguments[0] export_file_patterns =3D [] =20 diff --git a/scripts/kernel-doc b/scripts/kernel-doc index e57c5e989a0a..9b1e28426c0e 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -26,7 +26,7 @@ kernel-doc - Print formatted kernel documentation to stdo= ut =20 kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]]= [-Wcontents-before-sections] [ -man | - -rst [-sphinx-version VERSION] [-enable-lineno] | + -rst [-enable-lineno] | -none ] [ @@ -130,7 +130,6 @@ if ($#ARGV =3D=3D -1) { } =20 my $kernelversion; -my ($sphinx_major, $sphinx_minor, $sphinx_patch); =20 my $dohighlight =3D ""; =20 @@ -347,23 +346,6 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) { $enable_lineno =3D 1; } elsif ($cmd eq 'show-not-found') { $show_not_found =3D 1; # A no-op but don't fail - } elsif ($cmd eq "sphinx-version") { - my $ver_string =3D shift @ARGV; - if ($ver_string =3D~ m/^(\d+)(\.\d+)?(\.\d+)?/) { - $sphinx_major =3D $1; - if (defined($2)) { - $sphinx_minor =3D substr($2,1); - } else { - $sphinx_minor =3D 0; - } - if (defined($3)) { - $sphinx_patch =3D substr($3,1) - } else { - $sphinx_patch =3D 0; - } - } else { - die "Sphinx version should either major.minor or major.minor.p= atch format\n"; - } } else { # Unknown argument pod2usage( @@ -387,8 +369,6 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) { =20 # continue execution near EOF; =20 -# The C domain dialect changed on Sphinx 3. So, we need to check the -# version in order to produce the right tags. sub findprog($) { foreach(split(/:/, $ENV{PATH})) { @@ -396,42 +376,6 @@ sub findprog($) } } =20 -sub get_sphinx_version() -{ - my $ver; - - my $cmd =3D "sphinx-build"; - if (!findprog($cmd)) { - my $cmd =3D "sphinx-build3"; - if (!findprog($cmd)) { - $sphinx_major =3D 1; - $sphinx_minor =3D 2; - $sphinx_patch =3D 0; - printf STDERR "Warning: Sphinx version not found. Using defaul= t (Sphinx version %d.%d.%d)\n", - $sphinx_major, $sphinx_minor, $sphinx_patch; - return; - } - } - - open IN, "$cmd --version 2>&1 |"; - while () { - if (m/^\s*sphinx-build\s+([\d]+)\.([\d\.]+)(\+\/[\da-f]+)?$/) { - $sphinx_major =3D $1; - $sphinx_minor =3D $2; - $sphinx_patch =3D $3; - last; - } - # Sphinx 1.2.x uses a different format - if (m/^\s*Sphinx.*\s+([\d]+)\.([\d\.]+)$/) { - $sphinx_major =3D $1; - $sphinx_minor =3D $2; - $sphinx_patch =3D $3; - last; - } - } - close IN; -} - # get kernel version from env sub get_kernel_version() { my $version =3D 'unknown kernel version'; @@ -859,9 +803,10 @@ sub output_function_rst(%) { $signature .=3D ")"; } =20 - if ($sphinx_major < 3) { + if ($args{'typedef'} || $args{'functiontype'} eq "") { + print ".. c:macro:: ". $args{'function'} . "\n\n"; + if ($args{'typedef'}) { - print ".. c:type:: ". $args{'function'} . "\n\n"; print_lineno($declaration_start_line); print " **Typedef**: "; $lineprefix =3D ""; @@ -869,25 +814,10 @@ sub output_function_rst(%) { print "\n\n**Syntax**\n\n"; print " ``$signature``\n\n"; } else { - print ".. c:function:: $signature\n\n"; + print "``$signature``\n\n"; } } else { - if ($args{'typedef'} || $args{'functiontype'} eq "") { - print ".. c:macro:: ". $args{'function'} . "\n\n"; - - if ($args{'typedef'}) { - print_lineno($declaration_start_line); - print " **Typedef**: "; - $lineprefix =3D ""; - output_highlight_rst($args{'purpose'}); - print "\n\n**Syntax**\n\n"; - print " ``$signature``\n\n"; - } else { - print "``$signature``\n\n"; - } - } else { - print ".. c:function:: $signature\n\n"; - } + print ".. c:function:: $signature\n\n"; } =20 if (!$args{'typedef'}) { @@ -955,13 +885,9 @@ sub output_enum_rst(%) { my $count; my $outer; =20 - if ($sphinx_major < 3) { - my $name =3D "enum " . $args{'enum'}; - print "\n\n.. c:type:: " . $name . "\n\n"; - } else { - my $name =3D $args{'enum'}; - print "\n\n.. c:enum:: " . $name . "\n\n"; - } + my $name =3D $args{'enum'}; + print "\n\n.. c:enum:: " . $name . "\n\n"; + print_lineno($declaration_start_line); $lineprefix =3D " "; output_highlight_rst($args{'purpose'}); @@ -992,11 +918,8 @@ sub output_typedef_rst(%) { my $oldprefix =3D $lineprefix; my $name; =20 - if ($sphinx_major < 3) { - $name =3D "typedef " . $args{'typedef'}; - } else { - $name =3D $args{'typedef'}; - } + $name =3D $args{'typedef'}; + print "\n\n.. c:type:: " . $name . "\n\n"; print_lineno($declaration_start_line); $lineprefix =3D " "; @@ -1012,17 +935,13 @@ sub output_struct_rst(%) { my ($parameter); my $oldprefix =3D $lineprefix; =20 - if ($sphinx_major < 3) { - my $name =3D $args{'type'} . " " . $args{'struct'}; - print "\n\n.. c:type:: " . $name . "\n\n"; + my $name =3D $args{'struct'}; + if ($args{'type'} eq 'union') { + print "\n\n.. c:union:: " . $name . "\n\n"; } else { - my $name =3D $args{'struct'}; - if ($args{'type'} eq 'union') { - print "\n\n.. c:union:: " . $name . "\n\n"; - } else { - print "\n\n.. c:struct:: " . $name . "\n\n"; - } + print "\n\n.. c:struct:: " . $name . "\n\n"; } + print_lineno($declaration_start_line); $lineprefix =3D " "; output_highlight_rst($args{'purpose'}); @@ -2387,11 +2306,6 @@ sub process_file($) { close IN_FILE; } =20 - -if ($output_mode eq "rst") { - get_sphinx_version() if (!$sphinx_major); -} - $kernelversion =3D get_kernel_version(); =20 # generate a sequence of code that will splice in highlighting information @@ -2471,17 +2385,6 @@ Do not output documentation, only warnings. =20 =3Dhead3 reStructuredText only =20 -=3Dover 8 - -=3Ditem -sphinx-version VERSION - -Use the ReST C domain dialect compatible with a specific Sphinx Version. - -If not specified, kernel-doc will auto-detect using the sphinx-build versi= on -found on PATH. - -=3Dback - =3Dhead2 Output selection (mutually exclusive): =20 =3Dover 8 --=20 2.48.1