docs: document cpumode option for the cpuio ioengine

The cpumode option for the cpuio ioengine never had its own entry in the
documentation. Add an entry so that the documentation builds cleanly.

Signed-off-by: Vincent Fu <vincent.fu@samsung.com>

diff --git a/HOWTO b/HOWTO
index 74ba7216e132c358309ffd0961c2cb73ea7494be..4d8c799ef5da5294e05f8b30957d5c7e7c797074 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -2318,6 +2318,16 @@ with the caveat that when used on the command line, they must come after the
 
        Split the load into cycles of the given time. In microseconds.
 
 
        Split the load into cycles of the given time. In microseconds.
 

+.. option:: cpumode=str : [cpuio]
+
+       Specify how to stress the CPU. It can take these two values:
+
+       **noop**
+               This is the default where the CPU executes noop instructions.
+       **qsort**
+               Replace the default noop instructions loop with a qsort algorithm to
+               consume more energy.
+

 .. option:: exit_on_io_done=bool : [cpuio]
 
        Detect when I/O threads are done, then exit.
 .. option:: exit_on_io_done=bool : [cpuio]
 
        Detect when I/O threads are done, then exit.

diff --git a/fio.1 b/fio.1
index f32d791594e24ed46d818c407bcd79e1b6e57c18..e23d4092cce3cae460d65882969c1cafa4b34502 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -2091,6 +2091,19 @@ option when using cpuio I/O engine.
 .BI (cpuio)cpuchunks \fR=\fPint
 Split the load into cycles of the given time. In microseconds.
 .TP
 .BI (cpuio)cpuchunks \fR=\fPint
 Split the load into cycles of the given time. In microseconds.
 .TP

+.BI (cpuio)cpumode \fR=\fPstr
+Specify how to stress the CPU. It can take these two values:
+.RS
+.RS
+.TP
+.B noop
+This is the default and directs the CPU to execute noop instructions.
+.TP
+.B qsort
+Replace the default noop instructions with a qsort algorithm to consume more energy.
+.RE
+.RE
+.TP

 .BI (cpuio)exit_on_io_done \fR=\fPbool
 Detect when I/O threads are done, then exit.
 .TP
 .BI (cpuio)exit_on_io_done \fR=\fPbool
 Detect when I/O threads are done, then exit.
 .TP