Re: [RESEND RFC PATCH v1 10/20] docs: document general_profit sysfs knob

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@xxxxxxxxx> 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@xxxxxxxxx>
> -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