Blame SOURCES/docs-upgrade-tuna.8-man-page-with-option-r.patch

6230d8
From 3a07bae7e8539955bc3a0f4bafe82a8ff0e25fa9 Mon Sep 17 00:00:00 2001
6230d8
From: Daniel Bristot de Oliveira <daniel@bristot.me>
6230d8
Date: Thu, 25 Jun 2015 16:51:59 -0300
6230d8
Subject: [PATCH 2/2] docs: upgrade tuna.8 man page with option -r
6230d8
MIME-Version: 1.0
6230d8
Content-Type: text/plain; charset=UTF-8
6230d8
Content-Transfer-Encoding: 8bit
6230d8
6230d8
Update tuna.8 man page with the descriptions of the new command line
6230d8
options:
6230d8
       -r, --run="COMMAND"
6230d8
	      Run the COMMAND. If arguments are passed, the entire com‐
6230d8
	      mand line must be provided inside "quotes". Modifiers  -c
6230d8
	      and -p can be used to set the affinity and scheduler tun‐
6230d8
	      ables of the given COMMAND. The arg[0] (i.e. the command)
6230d8
	      will be set in THREAD-LIST.  Likewise the -t, the COMMAND
6230d8
	      accepts the prefix + and - as wildcards in  order  to  be
6230d8
	      appended or removed from THREAD-LIST, respectively.
6230d8
6230d8
And the modifications of -p behavior:
6230d8
       -p, --priority=[POLICY:]RTPRIO
6230d8
	      Set thread scheduler tunables: POLICY and RTPRIO.  POLICY
6230d8
	      is one of OTHER, FIFO, RR, or BATCH. If -t is not set, -p
6230d8
	      will act as a Modifier, saving  the  sched  tunables  for
6230d8
	      future Actions, for example -r.
6230d8
6230d8
And -t behavior:
6230d8
       -t, --threads=THREAD-LIST
6230d8
	      THREAD-LIST  affected by commands. Requires a thread num‐
6230d8
	      ber or thread name, or a comma-separated list  of  thread
6230d8
	      numbers and/or names. Thread names may contain wildcards.
6230d8
	      Be sure to quote or escape any  wildcard  specifications.
6230d8
	      If  only - is passed as argument, the THREAD-LIST will be
6230d8
	      cleared.
6230d8
6230d8
Signed-off-by: Daniel Bristot de Oliveira <daniel@bristot.me>
6230d8
Signed-off-by: John Kacur <jkacur@redhat.com>
6230d8
---
6230d8
 docs/tuna.8 | 7 +++++--
6230d8
 1 file changed, 5 insertions(+), 2 deletions(-)
6230d8
6230d8
diff --git a/docs/tuna.8 b/docs/tuna.8
6230d8
index a0a504cb13b9..81a42dd114a5 100644
6230d8
--- a/docs/tuna.8
6230d8
+++ b/docs/tuna.8
6230d8
@@ -35,7 +35,7 @@ Allow all threads to run on CPU\-LIST. Requires \fB\-c\fR or \fB-S\fR.
6230d8
 Move selected entities to CPU\-LIST. Requires \fB\-c\fR and either \fB-t\fR or \fB-q\fR.
6230d8
 .TP
6230d8
 \fB\-p\fR, \fB\-\-priority\fR=\fI[POLICY:]\fRRTPRIO
6230d8
-Set thread scheduler tunables: POLICY and RTPRIO. POLICY is one of OTHER, FIFO, RR, or BATCH. Requires \fB\-t\fR.
6230d8
+Set thread scheduler tunables: POLICY and RTPRIO. POLICY is one of OTHER, FIFO, RR, or BATCH. If \fB\-t\fR is not set, \fB\-p\fR will act as a Modifier saving the sched tunables for future Actions, for example \fB\-r\fR.
6230d8
 .TP
6230d8
 \fB\-P\fR, \fB\-\-show_threads\fR
6230d8
 Show thread list.
6230d8
@@ -43,6 +43,9 @@ Show thread list.
6230d8
 \fB\-s\fR, \fB\-\-save\fR=\fIFILENAME\fR
6230d8
 Save kthreads sched tunables to FILENAME.
6230d8
 .TP
6230d8
+\fB\-r\fR, \fB\-\-run\fR=\fI"COMMAND"\fR
6230d8
+Run the COMMAND. If arguments are passed, the entire command line must be provided inside "quotes". Modifiers \fB-c\fR and \fB-p\fR can be used to set the affinity and scheduler tunables of the given COMMAND. The arg[0] (i.e. the command) will be set in THREAD\-LIST. Likewise the \fB-t\fR, the COMMAND accepts the prefix \fB+\fR and \fB-\fR as wildcards in order to be appended or removed from THREAD\-LIST, respectively.
6230d8
+.TP
6230d8
 \fB\-v\fR, \fB\-\-version\fR
6230d8
 Show version
6230d8
 .TP
6230d8
@@ -75,7 +78,7 @@ IRQ\-LIST affected by commands. Requires an IRQ number or a comma-separated list
6230d8
 CPU\-SOCKET\-LIST affected by commands. Requires a socket number or a comma-separated list of socket numbers.
6230d8
 .TP
6230d8
 \fB\-t\fR, \fB\-\-threads\fR=\fITHREAD\-LIST\fR
6230d8
-THREAD\-LIST affected by commands. Requires a thread number or thread name, or a comma-separated list of thread numbers and/or names. Thread names may contain wildcards. Be sure to quote or escape any wildcard specifications.
6230d8
+THREAD\-LIST affected by commands. Requires a thread number or thread name, or a comma-separated list of thread numbers and/or names. Thread names may contain wildcards. Be sure to quote or escape any wildcard specifications. If only \fB-\fR is passed as argument, the THREAD\-LIST will be cleared.
6230d8
 .TP
6230d8
 \fB\-U\fR, \fB\-\-no_uthreads\fR
6230d8
 Operations will not affect user threads.
6230d8
-- 
6230d8
2.4.11
6230d8