Improved documentation.

1 files changed, 10 insertions, 5 deletions

diff --git a/tools/bmcompare/main.cpp b/tools/bmcompare/main.cpp
index 4bb6448..66c2a2d 100644
--- a/tools/bmcompare/main.cpp
+++ b/tools/bmcompare/main.cpp
@@ -37,10 +37,10 @@
          a set of XML files.
        - Third, run the bmcompare tool like this to compare the results:
 
-             ./bmcompare -ref ref1.xml ref2.xml ... -cmp cmp1.xml xmp2.xml ... -cmp ...
+             ./bmcompare -ref ref1.xml ref2.xml ... -cmp cmp1.xml cmp2.xml ... -cmp ...
 
-   The -ref option indicates that the following file names belong to the reference results,
-   while each -cmp option indicates that the following file names belong to the next set of
+   The -ref option specifies that the following file names belong to the reference results,
+   while each -cmp option specifies that the following file names belong to the next set of
    comparable results.
 
    The output is a table like this:
@@ -55,8 +55,13 @@
            <metric 2>   <value> <value> ...
            ...
 
-    Vertically, there is one group per unique function/tag combination (if several identical
-    combinations are detected, only the first one is used).
+    Vertically, there is one group per unique function/tag combination. The
+    function is the name of the test function that contains the QBENCHMARK
+    macro. The tag is the data tag that identifies a row of input data
+    specified by the corresponding _data function (i.e. matching the argument
+    to QTest::newRow()). The tag will be an empty string in the absence of a
+    _data function. If several identical function/tag combinations are
+    detected, only the first one is used.
 
     The rows in a group indicate results for each unique metric found for this function/tag
     combination (if several identical metrics are found for a combination, only the first one