OPAE Tools Documentation Update for 0.13.1 (1.0 PRQ) (#308)

(cherry picked from commit 8deeb64097f18c766e8c82abf989204ebd77cbfb)

doc/src/fpga_tools/coreidle/coreidle.md

@@ -7,9 +7,9 @@
 
 ## DESCRIPTION ##
 
-coreidle parses the Accelerator Function Unit (AFU) metadata and extracts power information. coreidle calculates the FPGA power 
-and calculates the number of online and idle cores. It moves threads from idle cores to online cores. coreidle is only available 
-the Integrated FPGA Platform. You cannot run coreidle on the PCIe Accelerator Card (PAC).
+```coreidle``` parses the Accelerator Function Unit (AFU) metadata and extracts power information. ```coreidle``` calculates
+the FPGA power and calculates the number of online and idle cores. It moves threads from idle cores to online cores. 
+```coreidle``` is only available the Integrated FPGA Platform. You cannot run ```coreidle``` on the PCIe Accelerator Card (PAC).
 
 
 ## EXAMPLES  ##
@@ -20,9 +20,9 @@ the Integrated FPGA Platform. You cannot run coreidle on the PCIe Accelerator Ca
 
 ## OPTIONS ##
 
-`-B,--bus` FPGA Bus number.
+`-B,--bus` FPGA bus number.
 
-`-D,--device` FPGA Device number.
+`-D,--device` FPGA device number.
 
 `-F,--functio` FPGA function number.
 

doc/src/fpga_tools/fpgabist/fpgabist.md

@@ -6,20 +6,20 @@ fpgabist [-h] [-i device_id] [-b bus] [-d device] [-f function] [path_to_gbs1 pa
 ```
 
 ## DESCRIPTION ##
-The fpgabist tool performs self-diagnostic tests on supported FPGA platforms.
+The ```fpgabist``` tool performs self-diagnostic tests on supported FPGA platforms.
 
 The tool accepts one or more Accelerator Function (AF) binaries from a predetermined set of AFs. Depending on the available binaries, 
 the tool runs appropriate tests and reports hardware issues.
 
-fpgabist always uses fpgainfo to report system information before running any hardware tests.
+```fpgabist``` always uses ```fpgainfo``` to report system information before running any hardware tests.
 
-Currently, fpgabist accepts the following AFs:
+Currently, ```fpgabist``` accepts the following AFs:
    1. nlb_mode_3 = host memory interface checking
    2. dma = local memory interface checking
 
 The platform includes the AF files, but you can also compile the AFs from the source. 
 
-If there are multiple devices, use -b, -d, -f to specify the BDF for the specific device. If you do not specify a BDF, fpgabist tests all cards.
+If there are multiple devices, use -b, -d, -f to specify the BDF for the specific device.
 
 ## POSITIONAL ARGUMENTS ##
 `[path_to_gbs1 path_to_gbs2 ...]`
@@ -51,6 +51,6 @@ If there are multiple devices, use -b, -d, -f to specify the BDF for the specifi
 
 `fpgabist <path_to_gbs_files>/dma_afu.gbs <path_to_gbs_files>/nlb_3.gbs`
 
- Runs fpgabist on any platforms in the system that match the default device ID. This command runs both the DMA and NLB_MODE_3 tests.
+ Runs ```fpgabist``` on any platforms in the system that match the default device ID. This command runs both the DMA and NLB_MODE_3 tests.
 
 

doc/src/fpga_tools/fpgaconf/fpgaconf.md

@@ -6,9 +6,8 @@
 
 ## DESCRIPTION ##
 
-fpgaconf configures the FPGA with the AF. It also checks the AF for compatibility with 
-the targeted FPGA and the FPGA Interface Manager (FIM). fpgaconf takes the
-following arguments:
+```fpgaconf``` configures the FPGA with the accelerator funciton (AF). It also checks the AF for compatibility with 
+the targeted FPGA and the FPGA Interface Manager (FIM). ```fpgaconf``` takes the following arguments:
 
 `-h, --help`
 
@@ -40,9 +39,9 @@ following arguments:
 
 	Socket number of the target FPGA.
 
-fpgaconf enumerates available FPGA devices in the system and selects
+```fpgaconf``` enumerates available FPGA devices in the system and selects
 compatible FPGAs for configuration. If more than one FPGA is
-compatible with the AF, fpgaconf exits and asks you to be
+compatible with the AF, ```fpgaconf``` exits and asks you to be
 more specific in selecting the target FPGAs by specifying a
 socket number or a PCIe BDF.
 

doc/src/fpga_tools/fpgad/fpgad.md

@@ -5,14 +5,15 @@
 `fpgad [--socket=<sock>] [--null-bitstream=<file>]`
 
 ## DESCRIPTION ##
-fpgad periodically monitors and reports the error status reflected in the device driver's error status sysfs files.
-fpgad establishes the channel to communicate events to the OPAE application. fpgad programs a NULL bitstream
-in response to an AP6 (power) event. fpgad is only available on the Integrated FPGA Platform. You cannot run
-fpgad on the PCIe Accelerator Card (PAC).
+```fpgad``` periodically monitors and reports the error status reflected in the device driver's error status sysfs files.
+```fpgad``` establishes the channel to communicate events to the Open Programmable Accelerator Engine (OPAE) application. 
+```fpgad``` programs a NULL bitstream in response to an AP6 (power) event. ```fpgad``` is only available on the Integrated FPGA
+Platform. You cannot run ```fpgad``` on the PCIe&reg; Accelerator Card (PAC).
 
-If your system does not support interrupts, you must run fpgad before the API calls `fpgaRegisterEvent` and `fpgaUnregisterEvent` can succeed.
+If your system does not support interrupts, you must run ```fpgad``` before the API calls `fpgaRegisterEvent` and
+`fpgaUnregisterEvent` can succeed.
 
-Use SIGINT to stop fpgad.
+Use SIGINT to stop ```fpgad```.
 
 `-d, --daemon`
 
@@ -21,22 +22,22 @@ Use SIGINT to stop fpgad.
 `-D, --directory <dir>`
 
     When running in daemon mode, run from the specified directory.
-    If omitted when daemonizing, /tmp is used.
+    If omitted when daemonizing, `fpgad` uses /tmp.
 
 `-l, --logfile <file>`
 
     When running in daemon mode, send output to file. When not in daemon mode, the output goes to stdout.
-    If omitted when daemonizaing, /tmp/fpgad.log is used.
+    If omitted when daemonizaing, fpgad uses /tmp/fpgad.log.
 
 `-p, --pidfile <file>`
 
     When running in daemon mode, write the daemon's process id to a file.
-    If omitted when daemonizing, /tmp/fpgad.pid is used.
+    If omitted when daemonizing, fpgad uses /tmp/fpgad.pid.
 
 `-m, --umask <mode>`
 
     When running in daemon mode, use the mode value as the file mode creation mask passed to umask.
-    If omitted when daemonizing, 0 is used.
+    If omitted when daemonizing, fpgad uses 0.
 
 `-s, --socket <sock>`