diff mbox series

[3/3] rt-tests: cyclictest: Add entry for mainaffinity in the manpage

Message ID 20210616231800.19228-3-jkacur@redhat.com
State New
Headers show
Series [1/3] cyclictest: Move main pid setaffinity handling into a function | expand

Commit Message

John Kacur June 16, 2021, 11:18 p.m. UTC
Add an entry for mainaffinity in the manpage.
Tweek the output in cyclictest for mainaffinity as well.

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 src/cyclictest/cyclictest.8 | 3 +++
 src/cyclictest/cyclictest.c | 3 ++-
 2 files changed, 5 insertions(+), 1 deletion(-)

Comments

Daniel Wagner June 17, 2021, 6:40 a.m. UTC | #1
Hi John,

On Wed, Jun 16, 2021 at 07:18:00PM -0400, John Kacur wrote:
> Add an entry for mainaffinity in the manpage.

> Tweek the output in cyclictest for mainaffinity as well.

> 

> Signed-off-by: John Kacur <jkacur@redhat.com>

> ---

>  src/cyclictest/cyclictest.8 | 3 +++

>  src/cyclictest/cyclictest.c | 3 ++-

>  2 files changed, 5 insertions(+), 1 deletion(-)

> 

> diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8

> index 4fe42e502535..abc56e8e4970 100644

> --- a/src/cyclictest/cyclictest.8

> +++ b/src/cyclictest/cyclictest.8

> @@ -94,6 +94,9 @@ Set the number of loops. The default is 0 (endless). This option is useful for a

>  .B \-\-laptop

>  Save battery when running cyclictest. This will give you poorer realtime results, but will not drain your battery so quickly.

>  .TP

> +.B \-\-mainaffinity=CPUSET

> +Run the main thread on CPU #N. This only affects the main thread and not the measurement threads


Nitpick: the .RI section is missing the --mainaffinity.

Reviewed-by: Daniel Wagner <dwagner@suse.de>
John Kacur June 17, 2021, 12:43 p.m. UTC | #2
On Thu, 17 Jun 2021, Daniel Wagner wrote:

> Hi John,

> 

> On Wed, Jun 16, 2021 at 07:18:00PM -0400, John Kacur wrote:

> > Add an entry for mainaffinity in the manpage.

> > Tweek the output in cyclictest for mainaffinity as well.

> > 

> > Signed-off-by: John Kacur <jkacur@redhat.com>

> > ---

> >  src/cyclictest/cyclictest.8 | 3 +++

> >  src/cyclictest/cyclictest.c | 3 ++-

> >  2 files changed, 5 insertions(+), 1 deletion(-)

> > 

> > diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8

> > index 4fe42e502535..abc56e8e4970 100644

> > --- a/src/cyclictest/cyclictest.8

> > +++ b/src/cyclictest/cyclictest.8

> > @@ -94,6 +94,9 @@ Set the number of loops. The default is 0 (endless). This option is useful for a

> >  .B \-\-laptop

> >  Save battery when running cyclictest. This will give you poorer realtime results, but will not drain your battery so quickly.

> >  .TP

> > +.B \-\-mainaffinity=CPUSET

> > +Run the main thread on CPU #N. This only affects the main thread and not the measurement threads

> 

> Nitpick: the .RI section is missing the --mainaffinity.


The Synopsis section doesn't have to be exhaustive, it just has to show 
typical usage. However, that section is crufty and could use some love.
For example, while we have the long version --policy, the short version -y
no longer exists but is mentioned there. Have a go at it if you're bored.

John

> 

> Reviewed-by: Daniel Wagner <dwagner@suse.de>

>
diff mbox series

Patch

diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index 4fe42e502535..abc56e8e4970 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -94,6 +94,9 @@  Set the number of loops. The default is 0 (endless). This option is useful for a
 .B \-\-laptop
 Save battery when running cyclictest. This will give you poorer realtime results, but will not drain your battery so quickly.
 .TP
+.B \-\-mainaffinity=CPUSET
+Run the main thread on CPU #N. This only affects the main thread and not the measurement threads
+.TP
 .B \-m, \-\-mlockall
 Lock current and future memory allocations to prevent being paged out
 .TP
diff --git a/src/cyclictest/cyclictest.c b/src/cyclictest/cyclictest.c
index 3477cd137c15..be8285a072b4 100644
--- a/src/cyclictest/cyclictest.c
+++ b/src/cyclictest/cyclictest.c
@@ -837,7 +837,8 @@  static void display_help(int error)
 	       "	 --laptop	   Save battery when running cyclictest\n"
 	       "			   This will give you poorer realtime results\n"
 	       "			   but will not drain your battery so quickly\n"
-	       "         --mainaffinity=[CPUSET]  Run the main thread on CPU #N. This only affects\n"
+	       "         --mainaffinity=CPUSET\n"
+	       "			   Run the main thread on CPU #N. This only affects\n"
 	       "                           the main thread and not the measurement threads\n"
 	       "-m       --mlockall        lock current and future memory allocations\n"
 	       "-M       --refresh_on_max  delay updating the screen until a new max\n"