Minor text correction Tools.md
Resolves openbmc/openbmc-test-automation#1403
Change-Id: I2fedd4e5eef27772ed1a10cfd0a0bf7f44812a17
Signed-off-by: Steven Sombar <ssombar@us.ibm.com>
diff --git a/Tools.md b/Tools.md
index 2526ffd..af648f9 100644
--- a/Tools.md
+++ b/Tools.md
@@ -1,15 +1,16 @@
-## Tools available in OpenBMC Test Automation ##
+## Tools used in OpenBMC Test Automation ##
## Hardware Test Executive (HTX): ##
HTX is a suite of test tools for stressing system hardware. It is routinely
used by the test suites under `systest/`. Refer to [README](https://github.com/open-power/HTX)
-## SEL to error log conversion procedure: ##
-Pre-requisite: A Power Linux system is required to build the tools.
+## Converting SELs to readable format: ##
-* Obtaining SEL parser tools:
+Pre-requisite: A Power Linux system is required.
+
+* Obtain the SEL (System Error Log) parser tools:
- Go to https://openpower.xyz/job/openpower-op-build/
- Click the link for the BMC system of interest (e.g. witherspoon)
- Click the "host_fw_debug.tar" link in order to download the tar file.
@@ -18,54 +19,53 @@
$ tar -xvf host_fw_debug.tar
```
- - Run the following to rename the untarred files:
+ - Rename the untarred files with:
```
$ for file_name in host_fw_debug* ; do mv $file_name ${file_name#host_fw_debug} ; done
```
- The files of interest are as follows:
+ The files of interest are:
eSEL.pl
hbotStringFile
hbicore.syms
-* An error log binary parser is also required:
+* The error log binary parser is also required:
- Go to https://sourceforge.net/projects/linux-diag/files/ppc64-diag/
- Download the latest release version of the source tar zipped.
- Extract the tarball and compile. Refer to README in the source.
- On successful compilation, get `opal-elog-parse` binary.
-* Generating error log from SEL binary data:
+* To generate a readable error log from binary SEL data:
- Run the following command:
-
- Create a directory and copy all the required binaries and script.
+ Create a directory and copy the binary files there. Next,
```
$ export PATH=$PATH:<path to directory>
```
-
+ And run
```
$ eSEL.pl -l SEL_data -p decode_obmc_data --op
```
where `SEL_data` is the file containing SEL binary data and option "--op"
will refer "opal-elog-parse" instead or errl.
- This command will generate a SEL_data.txt file.
+ The output file `SEL_data.txt` contains the readable error log (SEL) data.
-## The opal-prd tool: ##
- opal-prd is a tool used by the Energy Scale and RAS tests. It should be
- installed on the OS of the system under test before running those tests.
+## The opal-prd Tool: ##
+opal-prd is a tool used by the Energy Scale and RAS tests. It should be
+installed on the OS of the system under test before running those tests.
- opal-prd may be installed on Ubuntu with:
+opal-prd may be installed on Ubuntu with:
```
apt install opal-prd
```
and on RedHat with:
```
- yum install opal-prd
+ yum install opal-prd
```
+
## Obtain a copy of GitHub issues in CSV format: ##
Note: You will be prompted to enter your GitHub password.
@@ -84,7 +84,8 @@
$ python github_issues_to_csv <github user> openbmc/openbmc-test-automation
```
-## Generate Robot test cases documentation: ##
+
+## Generate Documentation for Robot Test Cases: ##
Usage:
```
@@ -101,3 +102,4 @@
```
$ ./tools/generate_test_document
```
+