linux-kernel - Re: [RESEND RFC PATCH v1 10/20] docs: document general

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87h6wfhpi8.fsf@meer.lwn.net>
Date:   Tue, 24 Jan 2023 09:21:51 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Bagas Sanjaya <bagasdotme@...il.com>,
        Stefan Roesch <shr@...kernel.io>, linux-mm@...ck.org
Cc:     linux-doc@...r.kernel.org, linux-fsdevel@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-kselftest@...r.kernel.org,
        linux-trace-kernel@...r.kernel.org
Subject: Re: [RESEND RFC PATCH v1 10/20] docs: document general_profit sysfs
 knob

Bagas Sanjaya <bagasdotme@...il.com> writes:

> Seems like the wording is confusing me, so I write the improv:
>
> ---- >8 ----
> diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm
> index 7768e90f7a8fef..5309a912ab679b 100644
> --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm
> +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm
> @@ -56,6 +56,6 @@ What:		/sys/kernel/mm/ksm/general_profit
>  Date:		January 2023
>  KernelVersion:  6.1
>  Contact:	Linux memory management mailing list <linux-mm@...ck.org>
> -Description:	Measure how effective KSM is.
> -		general_profit: how effective is KSM. The formula for the
> -		calculation is in Documentation/admin-guide/mm/ksm.rst.
> +Description:	Measure the KSM profit. See
> +		:ref:`KSM documentation <monitoring-ksm-profit>` for details
> +		on the calculated formula.

So the original at least attempted to tell us what "KSM profit" is; the
"improved" version makes no such effort.  I don't think that is actually
better.

jon