public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description
       [not found] <20240313012451.1693807-1-joel@joelfernandes.org>
@ 2024-03-13  1:24 ` Joel Fernandes (Google)
  2024-03-13 19:14   ` Chris Hyser
  2024-04-05  9:32   ` Daniel Bristot de Oliveira
  0 siblings, 2 replies; 4+ messages in thread
From: Joel Fernandes (Google) @ 2024-03-13  1:24 UTC (permalink / raw)
  To: linux-kernel, Thomas Gleixner, Borislav Petkov, Peter Zijlstra,
	Josh Poimboeuf, Pawan Gupta, Jonathan Corbet
  Cc: Suleiman Souhlal, Youssef Esmat, Steven Rostedt, David Vernet,
	Paul E . McKenney, joseph.salisbury, Dietmar Eggemann, Ben Segall,
	Mel Gorman, Daniel Bristot de Oliveira, Valentin Schneider,
	Luca Abeni, Tommaso Cucinotta, Vineeth Pillai, Shuah Khan,
	Phil Auld, Joel Fernandes (Google), linux-doc

Correct the description for arg4 which appears to be outdated.

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
+    is ``PIDTYPE_TGID``, then the operation of this command
     will be performed for all tasks in the task group of ``pid``.
 
 arg5:
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description
  2024-03-13  1:24 ` [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description Joel Fernandes (Google)
@ 2024-03-13 19:14   ` Chris Hyser
  2024-03-13 19:26     ` Chris Hyser
  2024-04-05  9:32   ` Daniel Bristot de Oliveira
  1 sibling, 1 reply; 4+ messages in thread
From: Chris Hyser @ 2024-03-13 19:14 UTC (permalink / raw)
  To: Joel Fernandes (Google), linux-kernel, Thomas Gleixner,
	Borislav Petkov, Peter Zijlstra, Josh Poimboeuf, Pawan Gupta,
	Jonathan Corbet
  Cc: Suleiman Souhlal, Youssef Esmat, Steven Rostedt, David Vernet,
	Paul E . McKenney, joseph.salisbury, Dietmar Eggemann, Ben Segall,
	Mel Gorman, Daniel Bristot de Oliveira, Valentin Schneider,
	Luca Abeni, Tommaso Cucinotta, Vineeth Pillai, Shuah Khan,
	Phil Auld, linux-doc


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>


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description
  2024-03-13 19:14   ` Chris Hyser
@ 2024-03-13 19:26     ` Chris Hyser
  0 siblings, 0 replies; 4+ messages in thread
From: Chris Hyser @ 2024-03-13 19:26 UTC (permalink / raw)
  To: Joel Fernandes (Google), linux-kernel, Thomas Gleixner,
	Borislav Petkov, Peter Zijlstra, Josh Poimboeuf, Pawan Gupta,
	Jonathan Corbet
  Cc: Suleiman Souhlal, Youssef Esmat, Steven Rostedt, David Vernet,
	Paul E . McKenney, joseph.salisbury, Dietmar Eggemann, Ben Segall,
	Mel Gorman, Daniel Bristot de Oliveira, Valentin Schneider,
	Luca Abeni, Tommaso Cucinotta, Vineeth Pillai, Shuah Khan,
	Phil Auld, linux-doc

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>
>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description
  2024-03-13  1:24 ` [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description Joel Fernandes (Google)
  2024-03-13 19:14   ` Chris Hyser
@ 2024-04-05  9:32   ` Daniel Bristot de Oliveira
  1 sibling, 0 replies; 4+ messages in thread
From: Daniel Bristot de Oliveira @ 2024-04-05  9:32 UTC (permalink / raw)
  To: Joel Fernandes (Google), linux-kernel, Thomas Gleixner,
	Borislav Petkov, Peter Zijlstra, Josh Poimboeuf, Pawan Gupta,
	Jonathan Corbet
  Cc: Suleiman Souhlal, Youssef Esmat, Steven Rostedt, David Vernet,
	Paul E . McKenney, joseph.salisbury, Dietmar Eggemann, Ben Segall,
	Mel Gorman, Valentin Schneider, Luca Abeni, Tommaso Cucinotta,
	Vineeth Pillai, Shuah Khan, Phil Auld, linux-doc

On 3/13/24 02:24, Joel Fernandes (Google) wrote:
> Correct the description for arg4 which appears to be outdated.
> 
> Signed-off-by: Joel Fernandes (Google) <joel@joelfernandes.org>

Maybe it is better to keep these tests into a separated thread (?) Because they
are touching things that are not about the server, so it might create conflicts...

What I did in the past when adding a series that was part in the kernel (tracer)
and part of tools (rtla) was to split them into two series, then referencing
one on the other - Steven suggested... and it was a good thing... and
reduced the number of versions.

So I am not adding these self-tests on top of the dl series for now... because
there is also discussion about the patches... and I am not an expert in the
selftests.... I will add a reference to this thread in the v6 cover and keep
updating it as new versions show up... in this way, one thing does not block
the other.

Thoughts?

-- Daniel

> ---
>  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
> +    is ``PIDTYPE_TGID``, then the operation of this command
>      will be performed for all tasks in the task group of ``pid``.
>  
>  arg5:


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2024-04-05  9:33 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
     [not found] <20240313012451.1693807-1-joel@joelfernandes.org>
2024-03-13  1:24 ` [PATCH v2 09/15] admin-guide/hw-vuln: Correct prctl() argument description Joel Fernandes (Google)
2024-03-13 19:14   ` Chris Hyser
2024-03-13 19:26     ` Chris Hyser
2024-04-05  9:32   ` Daniel Bristot de Oliveira

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox