public inbox for linux-rt-users@vger.kernel.org
 help / color / mirror / Atom feed
From: John Kacur <jkacur@redhat.com>
To: RT <linux-rt-users@vger.kernel.org>
Cc: Clark Williams <williams@redhat.com>,
	Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
	Pierre FICHEUX <pierre.ficheux@smile.fr>,
	Thomas Gleixner <tglx@linutronix.de>,
	Punit Agrawal <punitagrawal@gmail.com>,
	John Ogness <john.ogness@linutronix.de>,
	Luis Goncalves <lgoncalv@redhat.com>,
	Leah Leshchinsky <lleshchi@redhat.com>,
	John Kacur <jkacur@redhat.com>
Subject: [PATCH 2/3] rt-tests: Update the help and man page for --latency
Date: Fri,  1 Oct 2021 13:29:36 -0400	[thread overview]
Message-ID: <20211001172937.13060-2-jkacur@redhat.com> (raw)
In-Reply-To: <20211001172937.13060-1-jkacur@redhat.com>

- Update the help and man page for --latency
- Fix some sorting of --latency and --loops

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 src/cyclictest/cyclictest.8 | 12 ++++++------
 src/cyclictest/cyclictest.c |  6 ++++--
 2 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/src/cyclictest/cyclictest.8 b/src/cyclictest/cyclictest.8
index abc56e8e4970..dc0a278f3d30 100644
--- a/src/cyclictest/cyclictest.8
+++ b/src/cyclictest/cyclictest.8
@@ -67,9 +67,6 @@ Specify a length for the test run.
 .br
 Append 'm', 'h', or 'd' to specify minutes, hours or days.
 .TP
-.B \-\-latency=PM_Q0S
-write PM_Q0S to /dev/cpu_dma_latency
-.TP
 .B \-F, \-\-fifo=<path>
 Create a named pipe at path and write stats to it
 .TP
@@ -88,12 +85,15 @@ Set the base interval of the thread(s) in microseconds (default is 1000us). This
 .B \-\-json=FILENAME
 Write final results into FILENAME, JSON formatted.
 .TP
-.B \-l, \-\-loops=LOOPS
-Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.
-.TP
 .B \-\-laptop
 Save battery when running cyclictest. This will give you poorer realtime results, but will not drain your battery so quickly.
 .TP
+.B \-\-latency=PM_Q0S
+power management latency target value. This value is written to /dev/cpu_dma_latency and affects c-states. The default is 0
+.TP
+.B \-l, \-\-loops=LOOPS
+Set the number of loops. The default is 0 (endless). This option is useful for automated tests with a given number of test cycles. Cyclictest is stopped once the number of timer intervals has been reached.
+.TP
 .B \-\-mainaffinity=CPUSET
 Run the main thread on CPU #N. This only affects the main thread and not the measurement threads
 .TP
diff --git a/src/cyclictest/cyclictest.c b/src/cyclictest/cyclictest.c
index f8f7dbc7e43d..067b75317c9a 100644
--- a/src/cyclictest/cyclictest.c
+++ b/src/cyclictest/cyclictest.c
@@ -823,7 +823,6 @@ static void display_help(int error)
 	       "-d DIST  --distance=DIST   distance of thread intervals in us, default=500\n"
 	       "-D       --duration=TIME   specify a length for the test run.\n"
 	       "                           Append 'm', 'h', or 'd' to specify minutes, hours or days.\n"
-	       "	 --latency=PM_QOS  write PM_QOS to /dev/cpu_dma_latency\n"
 	       "-F       --fifo=<path>     create a named pipe at path and write stats to it\n"
 	       "-h       --histogram=US    dump a latency histogram to stdout after the run\n"
 	       "                           US is the max latency time to be tracked in microseconds\n"
@@ -832,10 +831,13 @@ static void display_help(int error)
 	       "	 --histfile=<path> dump the latency histogram to <path> instead of stdout\n"
 	       "-i INTV  --interval=INTV   base interval of thread in us default=1000\n"
 	       "         --json=FILENAME   write final results into FILENAME, JSON formatted\n"
-	       "-l LOOPS --loops=LOOPS     number of loops: default=0(endless)\n"
 	       "	 --laptop	   Save battery when running cyclictest\n"
 	       "			   This will give you poorer realtime results\n"
 	       "			   but will not drain your battery so quickly\n"
+	       "         --latency=PM_QOS  power management latency target value\n"
+	       "                           This value is written to /dev/cpu_dma_latency\n"
+	       "                           and affects c-states. The default is 0\n"
+	       "-l LOOPS --loops=LOOPS     number of loops: default=0(endless)\n"
 	       "         --mainaffinity=CPUSET\n"
 	       "			   Run the main thread on CPU #N. This only affects\n"
 	       "                           the main thread and not the measurement threads\n"
-- 
2.31.1


  reply	other threads:[~2021-10-01 17:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-01 17:29 [PATCH 1/3] rt-tests: Add *.dat to .gitignore John Kacur
2021-10-01 17:29 ` John Kacur [this message]
2021-10-01 17:29 ` [PATCH 3/3] rt-tests: cyclictest: Add --default-system option John Kacur
2021-10-04 11:39   ` Punit Agrawal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211001172937.13060-2-jkacur@redhat.com \
    --to=jkacur@redhat.com \
    --cc=bigeasy@linutronix.de \
    --cc=john.ogness@linutronix.de \
    --cc=lgoncalv@redhat.com \
    --cc=linux-rt-users@vger.kernel.org \
    --cc=lleshchi@redhat.com \
    --cc=pierre.ficheux@smile.fr \
    --cc=punitagrawal@gmail.com \
    --cc=tglx@linutronix.de \
    --cc=williams@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox