[Adding hpc documentation about sum and map, push to STABLE.
andy@unsafeperformio.com**20071025050341] {
hunk ./docs/users_guide/profiling.xml 1396
- combine Combine multiple .tix files in a single .tix files
+ sum Sum multiple .tix files in a single .tix file
+ combine Combine two .tix files in a single .tix file
+ map Map a function over a single .tix file
hunk ./docs/users_guide/profiling.xml 1454
-% hpc help markup
+$ hpc help markup
hunk ./docs/users_guide/profiling.xml 1471
+ hpc sum
+ hpc sum adds together any number of .tix files into a single
+ .tix file. hpc sum does not change the original .tix file; it generates a new .tix file.
+
+
+$ hpc help sum
+Usage: hpc sum [OPTION] .. <TIX_FILE> [<TIX_FILE> [<TIX_FILE> ..]]
+Sum multiple .tix files in a single .tix file
+
+Options:
+
+ --exclude=[PACKAGE:][MODULE] exclude MODULE and/or PACKAGE
+ --include=[PACKAGE:][MODULE] include MODULE and/or PACKAGE
+ --output=FILE output FILE
+ --union use the union of the module namespace (default is intersection)
+
+
hunk ./docs/users_guide/profiling.xml 1489
- hpc combine is the swiss army knife of hpc. Typically, combine is used
- to add .tix files together to get the combined total coverage. However, it can
- also be used to take the difference between .tix files, to subtract one
- .tix file from another, and to zero the .tix files. hpc combine does not
+ hpc combine is the swiss army knife of hpc. It can be
+ used to take the difference between .tix files, to subtract one
+ .tix file from another, or to add two .tix files. hpc combine does not
+ change the original .tix file; it generates a new .tix file.
+
+
+$ hpc help combine
+Usage: hpc combine [OPTION] .. <TIX_FILE> <TIX_FILE>
+Combine two .tix files in a single .tix file
+
+Options:
+
+ --exclude=[PACKAGE:][MODULE] exclude MODULE and/or PACKAGE
+ --include=[PACKAGE:][MODULE] include MODULE and/or PACKAGE
+ --output=FILE output FILE
+ --function=FUNCTION combine .tix files with join function, default = ADD
+ FUNCTION = ADD | DIFF | SUB
+ --union use the union of the module namespace (default is intersection)
+
+
+ hpc map
+ hpc map inverts or zeros a .tix file. hpc map does not
hunk ./docs/users_guide/profiling.xml 1514
-hpc help combine
-Usage: hpc combine [OPTION] .. <TIX_FILE> [<TIX_FILE> [<TIX_FILE> ..]]
+$ hpc help map
+Usage: hpc map [OPTION] .. <TIX_FILE>
+Map a function over a single .tix file
hunk ./docs/users_guide/profiling.xml 1523
- --combine=FUNCTION combine .tix files with join function, default = ADD
- FUNCTION = ADD | DIFF | SUB | ZERO
- --post-invert invert output; ticked becomes unticked, unticked becomes ticked
+ --function=FUNCTION apply function to .tix files, default = ID
+ FUNCTION = ID | INV | ZERO
+ --union use the union of the module namespace (default is intersection)
}