[ewg] [PATCH] perftest README update

[Oren Meron]

Update perftest README

Signed-off-by: Oren Meron <orenmeron at dev.mellanox.co.il>

--- a/README
+++ b/README
@@ -1,5 +1,5 @@
             Open Fabrics Enterprise Distribution (OFED)
-                Performance Tests README for OFED 1.2
+                Performance Tests README for OFED 1.3
                  
                          February 2008
 
@@ -9,7 +9,7 @@
 Table of Contents
 ===============================================================================
 1. Overview
-2. Notes on Testing Methodology
+2. Notes on Testing Method
 3. Test Descriptions
 4. Running Tests
 
@@ -18,30 +18,30 @@ Table of Contents
 ===============================================================================
 This is a collection of tests written over uverbs intended for use as a
 performance micro-benchmark. As an example, the tests can be used for
-HW or SW tuning and/or functional testing.
+hardware or software tuning and/or functional testing.
 
-Please post results/observations to the openib-general mailing list.
+Please post results and observations to the openib-general mailing list.
 See "Contact Us" at http://openib.org/mailman/listinfo/openib-general and
 http://www.openib.org.
 
 
 ===============================================================================
-2. Notes on Testing Methodology
+2. Notes on Testing Method
 ===============================================================================
-- The benchmark used the CPU cycle counter to get time stamps without context
-  switch.  Some CPU architectures (e.g., Intel's 80486 or older PPC) do NOT
-  have such capability.
+- The benchmark uses the CPU cycle counter to get time stamps without a context
+  switch. Some CPU architectures (e.g., Intel's 80486 or older PPC) do NOT have
+  such capability.
 
 - The benchmark measures round-trip time but reports half of that as one-way
   latency. This means that it may not be sufficiently accurate for asymmetrical
   configurations.
 
-- Min/Median/Max result is reported.
-  The median (vs average) is less sensitive to extreme scores.
-  Typically, the "Max" value is the first value measured.
+- Min/Median/Max results are reported.
+  The Median (vs average) is less sensitive to extreme scores.
+  Typically, the Max value is the first value measured.
 
-- Larger samples help marginally only. The default (1000) is pretty good.
-  Note that an array of cycles_t (typically unsigned long) is allocated
+- Larger samples only help marginally. The default (1000) is very satisfactory.
+  Note that an array of cycles_t (typically an unsigned long) is allocated
   once to collect samples and again to store the difference between them.
   Really big sample sizes (e.g., 1 million) might expose other problems
   with the program.
@@ -53,30 +53,31 @@ http://www.openib.org.
 Architectures tested:  i686, x86_64, ia64
 
 
-
 ===============================================================================
-4. Test Descriptions
+3. Test Descriptions
 ===============================================================================
 
 rdma_lat.c     latency test with RDMA write transactions
-rdma_bw.c      streaming BW test with RDMA write transactions
+rdma_bw.c      streaming bandwidth test with RDMA write transactions
 
 
-The following tests are mainly useful for HW/SW benchmarking.
+The following tests are mainly useful for hardware/software benchmarking.
 They are not intended as actual usage examples.
 
 send_lat.c     latency test with send transactions
-send_bw.c      BW test with send transactions
+send_bw.c      bandwidth test with send transactions
 write_lat.c    latency test with RDMA write transactions
-write_bw.c     BW test with RDMA write transactions
+write_bw.c     bandwidth test with RDMA write transactions
 read_lat.c     latency test with RDMA read transactions
-read_bw.c      BW test with RDMA read transactions
+read_bw.c      bandwidth test with RDMA read transactions
+
+The executable name of each test starts with the general prefix "ib_";
+for example, ib_write_lat.
 
-The executable name of each test starts with the general prefix "ib_",
-e.g., ib_write_lat.
 
-Running Tests
--------------
+===============================================================================
+4. Running Tests
+===============================================================================
 
 Prerequisites: 
        kernel 2.6
@@ -101,14 +102,20 @@ Common Options to tests:
   -s, --size=<size>            size of message to exchange (default: 1)
   -a, --all                    run sizes from 2 till 2^23
   -t, --tx-depth=<dep>         size of tx queue (default: 50)
-  -g, --mcg                    send messages to multicast group 0xc001 (only available in send-UD)
+  -g, --mcg                    send messages to multicast group 0xc001
+                                       (only available in send-UD)
   -n, --iters=<iters>          number of exchanges (at least 100, default: 1000)
-  -C, --report-cycles          report times in cpu cycle units (default: microseconds)
-  -H, --report-histogram       print out all results (default: print summary only)
-  -U, --report-unsorted        (implies -H) print out unsorted results (default: sorted)
+  -C, --report-cycles          report times in cpu cycle units
+                                       (default: microseconds)
+  -H, --report-histogram       print out all results
+                                       (default: print summary only)
+  -U, --report-unsorted        (implies -H) print out unsorted results
+                                       (default: sorted)
   -V, --version                display version number
-  -I, --inline_size=<size>     max size of message to be sent in inline mode (default 400)
- .-N, --no peak-bw             cancel peak-bw calculation (default: peak-bw. only available in write_bw)
+  -I, --inline_size=<size>     max size of message to be sent in inline mode
+                                       (default 400)
+  -N, --no peak-bw             cancel peak-bw calculation
+                                       (default: peak-bw. only available in write_bw)
 
   *** IMPORTANT NOTE: You need to be running a Subnet Manager on the switch or
                      on one of the nodes in your fabric.