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 <sitsofe@yahoo.com>

diff --git a/HOWTO b/HOWTO
index a1513e1259f7cc3001fb185a662150a9527dba34..22a58496921ba229db6a413696595aaa014d5ca9 100644 (file)
--- 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
 
        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
        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`
 .. 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
 
 
 .. 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%
                        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`=<nr_of_cpu>
+                       of the CPU. In case of SMP machines, use :option:`numjobs`\=<nr_of_cpu>

                        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.
                        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.