From nobody Wed Oct 8 07:35:05 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 236D3246784; Tue, 1 Jul 2025 08:57:17 +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=1751360238; cv=none; b=YZ3xh4X6m0LrpHRRmM/pZrH/goVoXCubu/9KiyrIc4cLc7SNgU9RbIxh34oECjxUWQsxG06OOrFBpwLJVM1rFfAO0XJgJV6/IcokSsR/06drNkBSxisjdmHYNSd1AuTrEsUKp7aoYmWzi6zs/z0GeorDSDHgMEzAYeFB29HU40o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=JVXQ/8IYf8XnXtTQdEVwyxaiGUvK4wO6JQSfGjOdsb8=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=UQ3ZxuQ+z35Hm28sQKXPzpm2lVB394lRBeZoYXrSHUmzxz4lGiB32f0b8mG4ya9ywakyiCSSCBxMxVAdUiapP0kPSJo5R4/GREWjXp6BGzX19csUXXPphlSLuQJc2xwGM7F+dr/BhEVhAL8lMWgpGw4Kr8ZoadXaa3YhA4XQ+sU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=Bhh46ATT; 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="Bhh46ATT" Received: by smtp.kernel.org (Postfix) with ESMTPS id C505DC4CEEF; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360237; bh=JVXQ/8IYf8XnXtTQdEVwyxaiGUvK4wO6JQSfGjOdsb8=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=Bhh46ATTFHrOd+dIK3J5Xs6zGbIxEe7gp/qQk4eB+4fpy6WrEYEjulhJ0daQHb0Bq twxIG/sXzV4+7jiuNKoA7YclwAmZ9VU9f0/KnUTtG4inNeq4V6OMnwLpdRAET4JByb XDdEkugi7b31K0vsUQdVP0AP6vdmXidMjOsCissOzmbMZRH3vLWYfsgDZexy2LoMrI 4vppeF1Ky8I8tpNryZidhWTkAeFqtnJDhnF7R7gKYDqJqoAcXvLELdSKPHoiWXGZ6g o3ZqRNoZCdck/DBYZT28OMhr2Or+n1fQYqNbmmiSvusL/6m599D5v+z10kkbgUjBWe bwozHaDczCZ/A== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id B7245C8302F; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:42 +0200 Subject: [PATCH 1/6] docs: nixify check-sysctl-docs 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 Message-Id: <20250701-jag-sysctldoc-v1-1-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=723; i=joel.granados@kernel.org; h=from:subject:message-id; bh=JVXQ/8IYf8XnXtTQdEVwyxaiGUvK4wO6JQSfGjOdsb8=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjoukEx+FI2E8vSQQRccHuWoI9V1GcM0R7d fKbDkKzE3co9okBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LpAAoJELqXzVK3 lkFPbHMMAI06sGLAcctT2iDoYoE/iAsxas2+g68NDcMNxpeiUDzAlcKHcqy19oUW60QUNafaHbw XhZBaJFUFsXTtDn7IOAEtmosQ/kIHVMmkDdzvhzzOAEBxgIWTKygd7/0t5wQ+AVlJaREhqw5M4k ejm9QMffJ6cxlQvwlZ/B50nBTPQVPnH/LNHpP/Hc/LjZ59SrTcoOq55h5ni+/Z9hzCunhpDaV2b mUb44PwZRk8xanfhibjwR1CUk/EBTRNgcIPgCL66a/+AwGbEhr+TcoXVWKr+sL1tcbKxm9UNk+C 56u4lIMZNouNy3oiDq4qx0OvjtIbRxKlCjPW+tVvi2IAqFRwTDTYCLReBxc1vQzzpRhdzFxkbF+ eOHc4TiPgzxYqgy8WZw9Xlmd7sUlsEbgHE0miDath+JJ2jj/dCL7uwnFAW4BsupMwMZLTgFqg5X inKmhL/NfdUjCpkf3EPkAPpGVrqsm0pawB6v1HzsAjdY2eJTtc64AkZv4GZzNc6nmBEVpC7UuY3 30= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Use "#!/usr/bin/env -S gawk -f" instead of "#!/bin/gawk". Needed for testing in nix environments as they only provide /usr/bin/env at the standard location. Signed-off-by: Joel Granados --- scripts/check-sysctl-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs index 20274c63e7451a8722137e7077f4456f293f4e54..178dcf2888ffd21845e8464fc25= 95052c02ff4a3 100755 --- a/scripts/check-sysctl-docs +++ b/scripts/check-sysctl-docs @@ -1,4 +1,4 @@ -#!/usr/bin/gawk -f +#!/usr/bin/env -S gawk -f # SPDX-License-Identifier: GPL-2.0 =20 # Script to check sysctl documentation against source files --=20 2.47.2 From nobody Wed Oct 8 07:35:05 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 0ABD822259D; Tue, 1 Jul 2025 08:57:18 +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=1751360238; cv=none; b=FXVY+EsHoCljH+CDNg2koalBggvQkpu/VT49xn58uKod9Aa92VBBGX7ND6/a2cLdi4DX/CVmRclUJGMszasDXiqlMChSz1keFL3Chy0G6JuKEcuB9jn1SJxJ69KQe5/2KX1t7EYAshro8XozqaUmNQ5ksng3Oh0eRKLpvytfnkc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=4SwDv1lBWtZq4b3iXzi192DtKqn0vm08JtS+5Pq6gkE=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=XjAbXxgyiix8E0m9wTLDw7NKQ9uQWz9JChav0gSNsfWav4bbVorAPmmtDziQ9jYxKg3wkx2aKdPLsdZ9RHBroQ7nEDMMWGokufQrGylrb2YW27YZKKnN2aP7SlDwXQTA+h4ZhVVmpTfPqExaYwH2OHzilAf4MaOCMIz0j3tLZN8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=OEahNi76; 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="OEahNi76" Received: by smtp.kernel.org (Postfix) with ESMTPS id D9B17C4CEEE; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360237; bh=4SwDv1lBWtZq4b3iXzi192DtKqn0vm08JtS+5Pq6gkE=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=OEahNi7642nIp4UnaCb8lSgGAGeZUhZA0hiFBNsMu0en7mCQ4uCgta4ZflICPYR7N uzpl2QSbTzOs8GpQIthBa4jYQsUU2w1Rhg68YCDToC9yX0SI5nHGnuzdfy74srHeTl N8INFIBiWUifdP7Mnfit1GhTljpIjg4/8/iX/bvtlAEJ9eVRf7oGEp9jrQzMN+NzXk wPxkCwfg2n/QjTC7e3/HTvMAl8Jbh5jVEznP9AwpZchMrKAb7AoFFXBJc5F23aZY3G qWnFvrNMlGAnCdqnb2pSUdQ+NAyBHCgopW3xsWY6wo90WXT95ORAISFSzgnpvPs9Us CKgXDmjM9+Sjg== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id C4EBCC8303C; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:43 +0200 Subject: [PATCH 2/6] docs: Use skiplist when checking sysctl admin-guide 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 Message-Id: <20250701-jag-sysctldoc-v1-2-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1565; i=joel.granados@kernel.org; h=from:subject:message-id; bh=4SwDv1lBWtZq4b3iXzi192DtKqn0vm08JtS+5Pq6gkE=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjouk395j9INJu6XGoPtLhnYLVRImz/idRJ Bw1XhnQJa7A9IkBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LpAAoJELqXzVK3 lkFPByAL/AhVuluFhQDaN1/+hYluKuL1g+JPOvAP4y4xv+4ypZ8F5drM1GN4DF5TmyoRLxXOSte Hk+Owhk8bCsbQqMwaFhnSyAoEP0OgJFGOClUi+dqj8sVzOrrGVn26h9cXIHZitUYwb1THgZY6b3 Xn1k+BKUbkBU+jC34bUPBsHU5ikcShW6sVXGUTedVUutMDzCRknCEcEWDMPRIYtiboRU/FFY9cD cgNpkgw/IM3udgid7ijUOoYclmWebEdkcp3wJq0Aq/UVB2wJk0LXUQMomqlk6TeeulnBOOoS+6L u+h4pQ44Rw2zBEDS96IOrpN0RwHGaqVFVwzxj2GGQyxqk/BwxDjll1F3HcOpjhIHFC6M3ZsI89l 6aykS9jwuHMXaAk1aycsIZHgJhkWvSQqyEiN6IEQ46wObE4ygQTjlcHFlqDjmOUxXr4G99RdwLx liuj2ppd7SGWMIkl0sOX3OW/3VdiPiZ/D/m+INYc5s50dxN6A8LQlzXDgcJbGtaptV28509kBi3 WU= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Use a skiplist to "skip" the titles in the guide documentation (Documentation/admin-guide/sysctl/*) that are not sysctls. This will give a more accurate account of what sysctl are miss-documented. Signed-off-by: Joel Granados --- scripts/check-sysctl-docs | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs index 178dcf2888ffd21845e8464fc2595052c02ff4a3..568197cb1c0a84147785f05aabb= bc6ab9dd896bc 100755 --- a/scripts/check-sysctl-docs +++ b/scripts/check-sysctl-docs @@ -17,6 +17,18 @@ BEGIN { print "Please specify the table to look for using the table variable" > "= /dev/stderr" exit 1 } + + # Documentation title skiplist + skiplist[0] =3D "^Documentation for" + skiplist[1] =3D "Network core options$" + skiplist[2] =3D "POSIX message queues filesystem$" + skiplist[3] =3D "Configuration options" + skiplist[4] =3D ". /proc/sys/fs" + skiplist[5] =3D "^Introduction$" + skiplist[6] =3D "^seccomp$" + skiplist[7] =3D "^pty$" + skiplist[8] =3D "^firmware_config$" + skiplist[9] =3D "^random$" } =20 # The following globals are used: @@ -53,10 +65,11 @@ function printentry(entry) { =20 # Stage 1: build the list of documented entries FNR =3D=3D NR && /^=3D+$/ { - if (prevline ~ /Documentation for/) { - # This is the main title - next - } + for (i in skiplist) { + if (prevline ~ skiplist[i]) { + next + } + } =20 # The previous line is a section title, parse it $0 =3D prevline --=20 2.47.2 From nobody Wed Oct 8 07:35:05 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 4BBDF260590; Tue, 1 Jul 2025 08:57:18 +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=1751360238; cv=none; b=C/YY+dJ6DVvPrIY4YItllJC2E4iOADqS0s/5WNF9Gfc3Yn30C4M+pAmD6//1lrcMSgX59XIbHJx8L9uA52zxAd4a6vavIDq+idvTuqq7OH5tlUMLSbPID+YqeGMgFGWH8wpjJX5BcrarU0eIAdhFONGmVPBXejrbcrQsS1U1Ic4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=dEWKHLfVWADiu1QnYIwVkFpHz0JRRQExXjCQUaLKIu4=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=pSY2c1zH7cnplNjy4O8M6izJCiDF3tFcAMm6IxuVr1s6+PLbBR2JFU0DdwL2uW1xTeoPzkQj062or0/778A2Ev2f6y39W4jj8FejQKl8F+VoWCA7Zr/uoa5OWuitT2Jt1y53mYaxFOaDF07aZp7SozWi42LgbGQ75D0OglrXUhM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=ReaEsB3E; 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="ReaEsB3E" Received: by smtp.kernel.org (Postfix) with ESMTPS id DD135C4AF09; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360237; bh=dEWKHLfVWADiu1QnYIwVkFpHz0JRRQExXjCQUaLKIu4=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=ReaEsB3EaPR8rmbNzY8yX+QZaDj8KFP9YwWt92J1LaIkjgdPF2joJJ0QeLHWp9uP5 v+H+0DEBvxu3K2lonwCt/eYovGH0SrCgpRLdZIrnfthA3CT0KneF4Wq8FBsfKj7Y25 8NVZqQ/IaNXs/DDDXECVu2UYSJEk1lioARIzJfnYN3csGsd43ZcNP5LjJ3AU7yf4th 1JN7A9Cu4RDHqsfz1NQs7+juNduFCA2rLlJqFpgZyrkDosJyJo372su50rMvGoXUZs bO/70xbzatLXMYAvtx4rN7pyobwzuivuhqDs5naqeANKdDXTGEBye3yRAkdsW1jt2v amJG+//KqUXMw== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D29A4C7EE30; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:44 +0200 Subject: [PATCH 3/6] docs: Add awk section for ucount sysctl entries 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 Message-Id: <20250701-jag-sysctldoc-v1-3-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1085; i=joel.granados@kernel.org; h=from:subject:message-id; bh=dEWKHLfVWADiu1QnYIwVkFpHz0JRRQExXjCQUaLKIu4=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjoup1BoiQAVRdV9XfCUFoG/uF/frNFIkXC i+CR4U02T0/dYkBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LqAAoJELqXzVK3 lkFPVIAL/0vcTuIFspDtPyHHqoflZX6qS//pVY7/KpYONXZz54qbFsOYcvHsalOcGGRbEyeFThS KJkmT1iH2UU8KpuV8wdyHxS7BuJkSGBSCI06dqU1E7NuggI1xdSqJzpj3aj65vbrlVSF/Fw4ysg m+ooQgPBmxB2EjAFIL5ymNSvmEeLOtXCj8tpZf992bh3HlVjEWT0I76FstxyqDEDuKAZoeB32vC sre7GB8OXb8ePKNLeiICC7ntminZexu5r6dm1FWu2RRfiwx172eK9+/mKSKGfIqXJDe96/zEgC/ Ml3+i5C5zmoqqfjW8lgE/2Ey7ipB0efkUsUJvJNg40jcITxfeIhDSs8Tj3fzqPpCSdttwqc9DPk E8ScOJWN71+ny43P1VI7brgjJbjWztK8I/IPYJfuqATg7tOoDH6lEP5wH/V2xM3pNIRWQMMb3NY Hqs/UfkRALjcAXdH/gnssypUCpgQYVLzUM89LnLP3wx67tTwqi2o1ENGRLrQaVG7hk5Cjg37hS6 Yc= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Adjust the sysctl table detection to include the macro pattern used for the ucount ctl_tables. This prevents falsly assigning them as non-documented ctl_tables Signed-off-by: Joel Granados --- scripts/check-sysctl-docs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs index 568197cb1c0a84147785f05aabbbc6ab9dd896bc..3166012b9c6ea4435dc77afaadc= ff3a4944b1ca8 100755 --- a/scripts/check-sysctl-docs +++ b/scripts/check-sysctl-docs @@ -130,6 +130,14 @@ curtable && /\.procname[\t ]*=3D[\t ]*".+"/ { file[curentry] =3D FILENAME } =20 +curtable && /UCOUNT_ENTRY.*/ { + match($0, /UCOUNT_ENTRY\("([^"]+)"\)/, names) + curentry =3D names[1] + if (debug) print "Adding entry " curentry " to table " curtable + entries[curtable][curentry]++ + file[curentry] =3D FILENAME +} + /register_sysctl.*/ { match($0, /register_sysctl(|_init|_sz)\("([^"]+)" *, *([^,)]+)/, table= s) if (debug) print "Registering table " tables[3] " at " tables[2] --=20 2.47.2 From nobody Wed Oct 8 07:35:05 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 4BC422609F7; Tue, 1 Jul 2025 08:57:18 +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=1751360238; cv=none; b=ZVqgH2JvYmwr8Z9Bjjf+Idv8B/7Yld3TTIA88pdkPw3e088Ht7cHLamLRqg60Xu3K/spRUrURsodpTqfQGcEHKWJ3IyMmwImzfbp8xBMUfH5IQvIZHEtCYpNKtiNGN3nYNO0mtvyHQ4DaI78CGJOqmFavVar/cHSwjb9HDJ2eYw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=ePs3rKA84il3gm9cXFfVHZ3ucJrNb+nPVHECDo+XbZs=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=OwPdtwimcT5vZI/hQK1LHKDNg+vgbfZets8/1rmHJ4SZXY0wgIi4f8cqelctz+UHkvR7L7M1jyDqIL2AsREOsjhNb0lb0tpxjdXgIJvTFDW/JUdKyoMWYSQ3pAo1gMvNOSHxN+ec0VH8Wj3ywALd5gp7bJGCn1lT7cXHBIMiC9o= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=cNDFq16F; 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="cNDFq16F" Received: by smtp.kernel.org (Postfix) with ESMTPS id E99F9C4CEF3; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360238; bh=ePs3rKA84il3gm9cXFfVHZ3ucJrNb+nPVHECDo+XbZs=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=cNDFq16FletVTE+NfGeEhHIPc0QdYj0aOPGiETDNaNK3HOJpLXhe1IbKwg7zAtojZ bEbfePcBN0H4PCuSTT5PNspKsbjMs/IUzEpt3ULUMLrS38S/0o90LyW3BhBumkd3j/ tasLlAynfjPQvjxQt67kIzLKz66eqJGJWOsaHRnINVZHle6w1JRESDgxDYvPVQUbvw xm2lcv1B/K3ZHxx5B2jzh/U/nxw6YcVx2ZQ7q9TeeGZ4kx48zcb3zMhtJv9C1dcHLt nxAmB13ArM44FGDNKUMvvjGJ5TUxTSQiYCWgMG9QcyPx4ooVkLLf6qvIVsNc8ywLC+ ZulIlbCC2n/zg== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id E0662C8303F; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:45 +0200 Subject: [PATCH 4/6] docs: Remove colon from ctltable title in vm.rst 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 Message-Id: <20250701-jag-sysctldoc-v1-4-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1326; i=joel.granados@kernel.org; h=from:subject:message-id; bh=ePs3rKA84il3gm9cXFfVHZ3ucJrNb+nPVHECDo+XbZs=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjouoNu2I0ilCYWLHWWuG47LqYHwLaTWL3g OQqm4JJtVO3YokBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LqAAoJELqXzVK3 lkFP7iMMAI3NMJR99dSUgXyOUtmWmrLaFiCA2eWJ02jhi9jyeDG8vcCXeXnRXVtb0tGHTMA6/01 VoDeAh8fLOsUthbt3PfU7ZBmMfqEDJrF42hyug+KWNqNngAK9YKNsuQOVBluWaHhPzEdpH7DwMG B/qNvNttRWVTPsoVFh+tsNguiXU3J6zatmyEoi7zP5ycDkLu8nkL9AvzEaVilfn7R3R3kmGMTym IIv1bTqrHXE2mEomvaQ08a5PKPwQBva+ruTEnHxCxfu9TWRHqtwOkkqlsTMbFKykrny9P73idu5 5o+VXozhMUzwUBfS9I52vZ5gVhI3ezempQe1X2em4K15yWlNdu0EcJhll7EL9XxbtdrUfvVDKq6 6IJmwZFFGh5dE33oUaWUfw0/fdc5bjwIqKxreW4K+wPp71JHymE3zQ+9qxqA536z7fBJxOXQa7A 6NI/7JELVvyktBH3O8bWA55sb1fL+wIsAb6cJYUZcMl8VvFCPUuRHPooslppSBftwnb57C6rLu+ DU= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Removing them solves an issue where they were incorrectly considered as not implemented by the check-sysctl-docs script Signed-off-by: Joel Granados --- Documentation/admin-guide/sysctl/vm.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-= guide/sysctl/vm.rst index 9bef46151d53cd3130a4a14c8a66bfdc3a5561b4..4d71211fdad8d061ccdef57477c= e3dca5c78741d 100644 --- a/Documentation/admin-guide/sysctl/vm.rst +++ b/Documentation/admin-guide/sysctl/vm.rst @@ -465,8 +465,8 @@ The minimum value is 1 (1/1 -> 100%). The value less th= an 1 completely disables protection of the pages. =20 =20 -max_map_count: -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +max_map_count +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 This file contains the maximum number of memory map areas a process may have. Memory map areas are used as a side-effect of calling @@ -495,8 +495,8 @@ memory allocations. The default value depends on CONFIG_MEM_ALLOC_PROFILING_ENABLED_BY_DEFAULT. =20 =20 -memory_failure_early_kill: -=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 +memory_failure_early_kill +=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 Control how to kill processes when uncorrected memory error (typically a 2bit error in a memory module) is detected in the background by hardware --=20 2.47.2 From nobody Wed Oct 8 07:35:05 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 607A81FDD; Tue, 1 Jul 2025 08:57:18 +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=1751360238; cv=none; b=YBVGXakol41zZdpH4KRTTfuC8kyeH2VPDsb4BdWxbiBtf/FRDu+ktx47K/3DO1LwIJVQ5aLcirzjK6gBVAnt8Ms/RIornh9jQCXobFnO+Jurx4G6qEs7m4GC4IJGPOFt4AAi/p8UaqPbjz5HhFbuQInQmO5eWBywFY8gL3D1wIA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=WZgQ14D22dPLNcKEi9IjqUPAXlhupD02zXCi6Noet+Y=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=AuaSUXeoaFR3m+3bWjfwYzk/WYc+/DioS1iL6MfuYc7FYoFMl+WbuzhGhltgbWeFiIwVFiFUXDQSqMlcxH9XZfXWZ730VvwIjFNWC3GR/I9MDze7hGP0LSVeLC1yDlOcDRvbYe3qXQ6n0OtLEZYLUIVxyRrWhxa52SutbJwFbJ4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=J2ODeEEg; 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="J2ODeEEg" Received: by smtp.kernel.org (Postfix) with ESMTPS id 06881C4CEFB; Tue, 1 Jul 2025 08:57:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360238; bh=WZgQ14D22dPLNcKEi9IjqUPAXlhupD02zXCi6Noet+Y=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=J2ODeEEgPNRDu9oYlBwdaulZ8f/3Ww5Kk8nUVcACl0lyxIWOq+C/F3UiWDFWJMfEs qmMj5jjkM5McIu4DeeV+9/Wdmg3f6Fe1JUKFpu10Fp0gVuCFe+ToHWKZbe8sVawX1w byhS/y3cnV0ir+h0ZV1cP1cD4on9v0P6HM4oCiqMRgKHqWcf673UHhTDoz2tTVrCnw 76BI6mYQtpnl3aa6hrEq/84gz2YEsTPXjzGjxDszyjBuMAivuPWvsUal1uY2alEabK obhrKcGhqsdLTTN0cpBcJ2Vxb7WcK6JzG8m9gigEnRkOeUqC6iJh3de3iM1k+0KEC2 OUWyGX7N4ilgg== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id F045BC8303D; Tue, 1 Jul 2025 08:57:17 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:46 +0200 Subject: [PATCH 5/6] docs: Replace spaces with tabs in check-sysctl-docs 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 Message-Id: <20250701-jag-sysctldoc-v1-5-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=6467; i=joel.granados@kernel.org; h=from:subject:message-id; bh=WZgQ14D22dPLNcKEi9IjqUPAXlhupD02zXCi6Noet+Y=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjouvcIQVcgTjcMwYVUzjN9clCy+sHEF9p5 hcxDDX/MlPGXokBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LrAAoJELqXzVK3 lkFPCLgL/0lRvZ0dCLUwkAUFUrId8D+HSxIbi5ts9LpkVtQN+/aLjDaApT5YXFq0LvXbe7+mGXF chBdiVr0jGNHhpELcWG5iXprYpknA2Ef0xPSNy/FEjuAymi4UFZuxSHwzfUZmytK/dyrodTb8oM j84G7XarKoIMoD8owzE8lI8n6O8BZ3u4C83ry8tepNb3DPYLA5HO7Dc/wcxTdrpc+sat11Vyg3S egynAQEAPwKaWvl2jkiZs7yJ8abu1jBagkLlFkcHi1K0r4TDeYl2GsjM7lu7aRNKcYXo8kXdPhu o0JiBR/V3vn4kmxpBX/sKDEHSfymiLrg2cGF28Q82vUVQod/lFPmLv9YijvgXRQt3jrurLAvQOy 0CFHlL1pTRaGINjgYDR74msCNjQtwWQ4OWAXAMaZNiCqcXu4w2dQfpo292e8loG23FwWq7Onte1 Iocgogu1KdbcEKBPjlPLGqh1AsbOCxy70cbzHq+vPwncrQDhzJUas7/ADAPU6oCpH9zLfx1r6F6 kU= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Remove the combination of spaces and tabs in favor of just tabs. Signed-off-by: Joel Granados --- scripts/check-sysctl-docs | 163 +++++++++++++++++++++++-------------------= ---- 1 file changed, 81 insertions(+), 82 deletions(-) diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs index 3166012b9c6ea4435dc77afaadcff3a4944b1ca8..910fd8a9a2684aa709c1572e24f= c94d52b093381 100755 --- a/scripts/check-sysctl-docs +++ b/scripts/check-sysctl-docs @@ -13,10 +13,10 @@ # Specify -vdebug=3D1 to see debugging information =20 BEGIN { - if (!table) { + if (!table) { print "Please specify the table to look for using the table variable" > "= /dev/stderr" exit 1 - } + } =20 # Documentation title skiplist skiplist[0] =3D "^Documentation for" @@ -43,23 +43,23 @@ BEGIN { =20 # Remove punctuation from the given value function trimpunct(value) { - while (value ~ /^["&]/) { - value =3D substr(value, 2) - } - while (value ~ /[]["&,}]$/) { - value =3D substr(value, 1, length(value) - 1) - } - return value + while (value ~ /^["&]/) { + value =3D substr(value, 2) + } + while (value ~ /[]["&,}]$/) { + value =3D substr(value, 1, length(value) - 1) + } + return value } =20 # Print the information for the given entry function printentry(entry) { - seen[entry]++ - printf "* %s from %s", entry, file[entry] - if (documented[entry]) { - printf " (documented)" - } - print "" + seen[entry]++ + printf "* %s from %s", entry, file[entry] + if (documented[entry]) { + printf " (documented)" + } + print "" } =20 =20 @@ -71,105 +71,104 @@ FNR =3D=3D NR && /^=3D+$/ { } } =20 - # The previous line is a section title, parse it - $0 =3D prevline - if (debug) print "Parsing " $0 - inbrackets =3D 0 - for (i =3D 1; i <=3D NF; i++) { - if (length($i) =3D=3D 0) { - continue + # The previous line is a section title, parse it + $0 =3D prevline + if (debug) print "Parsing " $0 + inbrackets =3D 0 + for (i =3D 1; i <=3D NF; i++) { + if (length($i) =3D=3D 0) { + continue + } + if (!inbrackets && substr($i, 1, 1) =3D=3D "(") { + inbrackets =3D 1 + } + if (!inbrackets) { + token =3D trimpunct($i) + if (length(token) > 0 && token !=3D "and") { + if (debug) print trimpunct($i) + documented[trimpunct($i)]++ + } + } + if (inbrackets && substr($i, length($i), 1) =3D=3D ")") { + inbrackets =3D 0 + } } - if (!inbrackets && substr($i, 1, 1) =3D=3D "(") { - inbrackets =3D 1 - } - if (!inbrackets) { - token =3D trimpunct($i) - if (length(token) > 0 && token !=3D "and") { - if (debug) print trimpunct($i) - documented[trimpunct($i)]++ - } - } - if (inbrackets && substr($i, length($i), 1) =3D=3D ")") { - inbrackets =3D 0 - } - } } =20 FNR =3D=3D NR { - prevline =3D $0 - next + prevline =3D $0 + next } =20 =20 # Stage 2: process each file and find all sysctl tables BEGINFILE { - delete entries - curtable =3D "" - curentry =3D "" - delete vars - if (debug) print "Processing file " FILENAME + delete entries + curtable =3D "" + curentry =3D "" + delete vars + if (debug) print "Processing file " FILENAME } =20 /^static( const)? struct ctl_table/ { - match($0, /static( const)? struct ctl_table ([^][]+)/, tables) - curtable =3D tables[2] - if (debug) print "Processing table " curtable + match($0, /static( const)? struct ctl_table ([^][]+)/, tables) + curtable =3D tables[2] + if (debug) print "Processing table " curtable } =20 /^};$/ { - curtable =3D "" - curentry =3D "" - delete vars + curtable =3D "" + curentry =3D "" + delete vars } =20 curtable && /\.procname[\t ]*=3D[\t ]*".+"/ { - match($0, /.procname[\t ]*=3D[\t ]*"([^"]+)"/, names) - curentry =3D names[1] - if (debug) print "Adding entry " curentry " to table " curtable - entries[curtable][curentry]++ - file[curentry] =3D FILENAME + match($0, /.procname[\t ]*=3D[\t ]*"([^"]+)"/, names) + curentry =3D names[1] + if (debug) print "Adding entry " curentry " to table " curtable + entries[curtable][curentry]++ + file[curentry] =3D FILENAME } =20 curtable && /UCOUNT_ENTRY.*/ { - match($0, /UCOUNT_ENTRY\("([^"]+)"\)/, names) - curentry =3D names[1] - if (debug) print "Adding entry " curentry " to table " curtable - entries[curtable][curentry]++ - file[curentry] =3D FILENAME + match($0, /UCOUNT_ENTRY\("([^"]+)"\)/, names) + curentry =3D names[1] + if (debug) print "Adding entry " curentry " to table " curtable + entries[curtable][curentry]++ + file[curentry] =3D FILENAME } =20 /register_sysctl.*/ { - match($0, /register_sysctl(|_init|_sz)\("([^"]+)" *, *([^,)]+)/, table= s) - if (debug) print "Registering table " tables[3] " at " tables[2] - if (tables[2] =3D=3D table) { - for (entry in entries[tables[3]]) { - printentry(entry) - } - } + match($0, /register_sysctl(|_init|_sz)\("([^"]+)" *, *([^,)]+)/, tables) + if (debug) print "Registering table " tables[3] " at " tables[2] + if (tables[2] =3D=3D table) { + for (entry in entries[tables[3]]) { + printentry(entry) + } + } } =20 /kmemdup.*/ { - match($0, /([^ \t]+) *=3D *kmemdup\(([^,]+) *,/, names) - if (debug) print "Found variable " names[1] " for table " names[2] - if (names[2] in entries) { - vars[names[1]] =3D names[2] - } + match($0, /([^ \t]+) *=3D *kmemdup\(([^,]+) *,/, names) + if (debug) print "Found variable " names[1] " for table " names[2] + if (names[2] in entries) { + vars[names[1]] =3D names[2] + } } =20 /__register_sysctl_table.*/ { - match($0, /__register_sysctl_table\([^,]+, *"([^"]+)" *, *([^,]+)/, ta= bles) - if (debug) print "Registering variable table " tables[2] " at " tables= [1] - if (tables[1] =3D=3D table && tables[2] in vars) { - for (entry in entries[vars[tables[2]]]) { - printentry(entry) - } - } + match($0, /__register_sysctl_table\([^,]+, *"([^"]+)" *, *([^,]+)/, table= s) + if (debug) print "Registering variable table " tables[2] " at " tables[1] + if (tables[1] =3D=3D table && tables[2] in vars) { + for (entry in entries[vars[tables[2]]]) { + printentry(entry) + } + } } =20 END { - for (entry in documented) { - if (!seen[entry]) { - print "No implementation for " entry + for (entry in documented) { + if (!seen[entry]) + print "No implementation for " entry } - } } --=20 2.47.2 From nobody Wed Oct 8 07:35:05 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 61E1626A095; Tue, 1 Jul 2025 08:57:18 +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=1751360238; cv=none; b=tkWqRN8PhmfnKkUjQVmQNFMSJvM+nC70oIXrd7VtyOG2BZRzHHCmrGepQiEv4J1xeszuOAa6Evb/aQw2IXJ6iHjRpznZxjQlFT3YJ72mGitVc21+G4qtu7W3MEwGR/RKg5fxSWTZ+glZ0TcTA+nAsaQn7zTGH92x8OBggbTYRbE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751360238; c=relaxed/simple; bh=vmReX47mqCLgmmgZzbo16/Xw5onF/bS5D530hw5Anx8=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=O1+OZkiYQKZYn9o6kN+Ri6Mxr/qGeOpEoG53O45Hi0mjrkSYr3iBwoiNNqRLWnioaiV8i0JMvo+fXIEmFPdG/atoNogJ/x1XvhyPi8G1psNUhpgvaZwGIHLHkcG8km+C09AAs6No6+PKqmZ6+p2puP5l+cFqetzPRzRLZiN5BWc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=TOPCN3lE; 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="TOPCN3lE" Received: by smtp.kernel.org (Postfix) with ESMTPS id 1194EC4CEFD; Tue, 1 Jul 2025 08:57:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1751360238; bh=vmReX47mqCLgmmgZzbo16/Xw5onF/bS5D530hw5Anx8=; h=From:Date:Subject:References:In-Reply-To:To:Cc:From; b=TOPCN3lEFa9Pb04mHDONYZhWUehnQy/XLyKk96s791L+h1USqQRyA4hc3cG4FFZLw sf3uPeYnAvcMKvOb216bOzvNrcvmLCMrH2lyEaEo6Iy5TTOGiuPEAn/MwnxflhreUc gsr5GkJs9DkNf+FEFvJH7guc9x32yUpBk8hbuhpYbxGPI0JgQeItVYy87Hj8hlkUiq o1Y2UhDJh2V5cA8O+mOsyUUDIoP2d3w6hWKn70KbmIAK9ol9eY6rw773VduO6dpJCN 4xCAjqx3GmCJmTDmMBFgf0xe4HTOoHJvZsfo51WdGgZz/AaHPkOx3o6oxBNH7xzjuV Egk5Rs5DlIP6Q== Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0951BC8302F; Tue, 1 Jul 2025 08:57:18 +0000 (UTC) From: Joel Granados Date: Tue, 01 Jul 2025 10:56:47 +0200 Subject: [PATCH 6/6] docs: Downgrade arm64 & riscv from titles to comment 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 Message-Id: <20250701-jag-sysctldoc-v1-6-936912553f58@kernel.org> References: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org> To: Kees Cook , Jonathan Corbet , Paul Walmsley , Palmer Dabbelt , Albert Ou , Alexandre Ghiti Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org, Joel Granados X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=2491; i=joel.granados@kernel.org; h=from:subject:message-id; bh=vmReX47mqCLgmmgZzbo16/Xw5onF/bS5D530hw5Anx8=; b=owJ4nAHtARL+kA0DAAoBupfNUreWQU8ByyZiAGhjoutgafknIe4uDW/tuqngY3301IDb7siVv D+Ppdv3MEHYgIkBswQAAQoAHRYhBK5HCVcl5jElzssnkLqXzVK3lkFPBQJoY6LrAAoJELqXzVK3 lkFPIqYMAIw2aha8NP8P8uQJTcXrqi1uSeSVBitGs7JzTKKQH03EcYNNRzfXlq0GvfmC694C68K 589+Rg8OmUJyr8RY9P8gRir1sNTcfD377eXgw2JBiBuNYo3sjcy9AH74ytTRTmuKtgkfOgqLbQB L1t0O/8qy5g0lVo3UboWOEmAj28SisTNub/9IDCBLn/3YxVfeqlId3k6HJgp3E4Shr1Va8fwDHD DUGoZ45iqIKT4ZNSDZcTuZpo+kLYFF+Q1zDWD+vXV8BeBRbOblYB9Fq5dKKWWq4elk5K/LhMdyB ZwDosse7CN63dW+gi8zKu8wD1CcLQ7gBvQqcouX51yE/HMRlqiyIY8vvPhlOdzILOg7yZxdl5fh K5Swo/tIBbzJh5pPNb5A9s0wLS06nyLLFa7rKscBeWVqhHqUF0lU+Qbtd/wgiEowZt3jRumBlya qrzjEEq6B/3sp3UaVJUsfXH1j+4LAyb5+TgCSP4stcZ/rTULBR8x2KOtuq09XuOXDpQRa13oMI7 lk= X-Developer-Key: i=joel.granados@kernel.org; a=openpgp; fpr=F1F8E46D30F0F6C4A45FF4465895FAAC338C6E77 X-Endpoint-Received: by B4 Relay for joel.granados@kernel.org/default with auth_id=239 Remove the title string ("=3D=3D=3D=3D") from under arm64 & riscv and move = them to a commment under the perf_user_access sysctl. They are explanations, *not* sysctls themselves This effectively removes these two strings from appearing as not implemented when the check-sysctl-docs script is run Signed-off-by: Joel Granados --- Documentation/admin-guide/sysctl/kernel.rst | 32 +++++++++++++------------= ---- 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/ad= min-guide/sysctl/kernel.rst index dd49a89a62d3542fa1a599f318dff26589e1d57b..c2683ce17b25821559d0c04914a= ea360440c7309 100644 --- a/Documentation/admin-guide/sysctl/kernel.rst +++ b/Documentation/admin-guide/sysctl/kernel.rst @@ -1014,30 +1014,26 @@ perf_user_access (arm64 and riscv only) =20 Controls user space access for reading perf event counters. =20 -arm64 -=3D=3D=3D=3D=3D +* for arm64 + The default value is 0 (access disabled). =20 -The default value is 0 (access disabled). + When set to 1, user space can read performance monitor counter registers + directly. =20 -When set to 1, user space can read performance monitor counter registers -directly. + See Documentation/arch/arm64/perf.rst for more information. =20 -See Documentation/arch/arm64/perf.rst for more information. +* for riscv + When set to 0, user space access is disabled. =20 -riscv -=3D=3D=3D=3D=3D + The default value is 1, user space can read performance monitor counter + registers through perf, any direct access without perf intervention will= trigger + an illegal instruction. =20 -When set to 0, user space access is disabled. + When set to 2, which enables legacy mode (user space has direct access t= o cycle + and insret CSRs only). Note that this legacy value is deprecated and wil= l be + removed once all user space applications are fixed. =20 -The default value is 1, user space can read performance monitor counter -registers through perf, any direct access without perf intervention will t= rigger -an illegal instruction. - -When set to 2, which enables legacy mode (user space has direct access to = cycle -and insret CSRs only). Note that this legacy value is deprecated and will = be -removed once all user space applications are fixed. - -Note that the time CSR is always directly accessible to all modes. + Note that the time CSR is always directly accessible to all modes. =20 pid_max =3D=3D=3D=3D=3D=3D=3D --=20 2.47.2