From 71aa48eb4eed51adb719d159810ab0044b2a7154 Mon Sep 17 00:00:00 2001 From: Sitsofe Wheeler Date: Fri, 20 Oct 2017 07:08:37 +0100 Subject: [PATCH] doc: minor formatting fixes - Sphinx doesn't like non-punctuation characters directly after closing backticks unless they are escaped so add some backslashes appropriately. - Markup /proc/sys/kernel/shmmax in --max-jobs like other /proc/ references. Signed-off-by: Sitsofe Wheeler --- HOWTO | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/HOWTO b/HOWTO index a1513e12..22a58496 100644 --- a/HOWTO +++ b/HOWTO @@ -218,7 +218,7 @@ Command line options Set the maximum number of threads/processes to support to `nr`. NOTE: On Linux, it may be necessary to increase the shared-memory - limit ('/proc/sys/kernel/shmmax') if fio runs into errors while + limit (:file:`/proc/sys/kernel/shmmax`) if fio runs into errors while creating jobs. .. option:: --server=args @@ -233,7 +233,7 @@ Command line options .. option:: --client=hostname Instead of running the jobs locally, send and run them on the given `hostname` - or set of `hostname`s. See `Client/Server`_ section. + or set of `hostname`\s. See `Client/Server`_ section. .. option:: --remote-config=file @@ -1715,7 +1715,7 @@ I/O engine Doesn't transfer any data, but burns CPU cycles according to the :option:`cpuload` and :option:`cpuchunks` options. Setting :option:`cpuload`\=85 will cause that job to do nothing but burn 85% - of the CPU. In case of SMP machines, use :option:`numjobs`= + of the CPU. In case of SMP machines, use :option:`numjobs`\= to get desired CPU usage, as the cpuload only loads a single CPU at the desired rate. A job never finishes unless there is at least one non-cpuio job. -- 2.25.1