Re: [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description

Chris Hyser
2024-03-13T19:27:08Z

Sorry. This is a resend that should have better formatting.

On 3/13/24 15:14, Chris Hyser wrote:
>
> On 3/12/24 21:24, Joel Fernandes (Google) wrote:
>> Correct the description for arg4 which appears to be outdated.
>
> Technically, the constants referenced in the documentation are still
> defined in prctl.h, and there are BUILD_BUG_ON() checks to ensure they
> match their PIDTYPE_ equivalents. I would presume these should be left
> in as it is technically a defined interface and user code could break.
>
>
>> Signed-off-by: Joel Fernandes (Google) <joel@joelfernandes.org>
>> ---
>>   Documentation/admin-guide/hw-vuln/core-scheduling.rst | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/admin-guide/hw-vuln/core-scheduling.rst
>> b/Documentation/admin-guide/hw-vuln/core-scheduling.rst
>> index cf1eeefdfc32..338d639a8127 100644
>> --- a/Documentation/admin-guide/hw-vuln/core-scheduling.rst
>> +++ b/Documentation/admin-guide/hw-vuln/core-scheduling.rst
>> @@ -62,8 +62,8 @@ arg3:
>>     arg4:
>>       ``pid_type`` for which the operation applies. It is one of
>> -    ``PR_SCHED_CORE_SCOPE_``-prefixed macro constants.  For example,
>> if arg4
>> -    is ``PR_SCHED_CORE_SCOPE_THREAD_GROUP``, then the operation of
>> this command
>> +    ``PIDTIME_``-prefixed macro constants.  For example, if arg4

Presumably you mean PIDTYPE_ here? Otherwise looks good and in
retrospect this is probably what should have been done in the first place.

>> +    is ``PIDTYPE_TGID``, then the operation of this command
>>       will be performed for all tasks in the task group of ``pid``.
>>     arg5:
>
>
> Reviewed-by: Chris Hyser <chris.hyser@oracle.com>
>