Re: [PATCH v2] docs: sysctl: Add documentation for crypto and debug sysctls

[Randy Dunlap]

On 2/23/26 9:02 AM, Shubham Chakraborty wrote:
> The /proc/sys/crypto and /proc/sys/debug directories lacked
> documentation in the admin-guide. Add RST files covering
> fips_enabled, fips_name, fips_version, exception-trace, and
> kprobes-optimization sysctls.
> 
> Signed-off-by: Shubham Chakraborty <chakrabortyshubham66@xxxxxxxxx>

Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

I would change a couple of things below, but it's not worth
doing another version just for this.

> ---
>  Documentation/admin-guide/sysctl/crypto.rst | 49 +++++++++++++++++++
>  Documentation/admin-guide/sysctl/debug.rst  | 53 +++++++++++++++++++++
>  Documentation/admin-guide/sysctl/index.rst  |  6 ++-
>  3 files changed, 106 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/admin-guide/sysctl/crypto.rst
>  create mode 100644 Documentation/admin-guide/sysctl/debug.rst
> 
> diff --git a/Documentation/admin-guide/sysctl/crypto.rst b/Documentation/admin-guide/sysctl/crypto.rst
> new file mode 100644
> index 000000000..a4c2e5ed4
> --- /dev/null
> +++ b/Documentation/admin-guide/sysctl/crypto.rst
> @@ -0,0 +1,49 @@
> +=================
> +/proc/sys/crypto/
> +=================
> +
> +Currently, these files might (depending on your configuration)

Drop "Currently,". That's what we try to document (even though
files get of out date easily and quickly).
Besides, having 3 (what are they? conditionals; caveats;
exceptions?) qualifiers in one sentence could be too much.
(I'm referring to: Currently, might, depending).

> +show up in ``/proc/sys/crypto/``:
> +
> +.. contents:: :local:
> +
> +fips_enabled
> +============


> diff --git a/Documentation/admin-guide/sysctl/debug.rst b/Documentation/admin-guide/sysctl/debug.rst
> new file mode 100644
> index 000000000..a836c091d
> --- /dev/null
> +++ b/Documentation/admin-guide/sysctl/debug.rst
> @@ -0,0 +1,53 @@
> +================
> +/proc/sys/debug/
> +================
> +
> +Currently, these files might (depending on your configuration)
> +show up in ``/proc/sys/debug/``:

Same comment for "Currently," here.

> +
> +.. contents:: :local:
> +
> +exception-trace
> +===============

-- 
~Randy