X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fusers_guide%2Fprofiling.xml;fp=docs%2Fusers_guide%2Fprofiling.xml;h=9a1f2894834881cb612b5cfe2e4383f5b055ab43;hb=7895455f8dc327c6b447f9287d6e76ddcd253183;hp=d55cfd9702120684dc1c66746216defe4f555ab6;hpb=46935808127fe8d7a66bd52f884d2b50d3e33f6d;p=ghc-hetmet.git diff --git a/docs/users_guide/profiling.xml b/docs/users_guide/profiling.xml index d55cfd9..9a1f289 100644 --- a/docs/users_guide/profiling.xml +++ b/docs/users_guide/profiling.xml @@ -1393,7 +1393,9 @@ Reporting Coverage: report Output textual report about program coverage markup Markup Haskell source with program coverage Processing Coverage files: - 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 Coverage Overlays: overlay Generate a .tix file from an overlay file draft Generate draft overlay that provides 100% coverage @@ -1449,7 +1451,7 @@ Options: hpc markup marks up source files into colored html. -% hpc help markup +$ hpc help markup Usage: hpc markup [OPTION] .. <TIX_FILE> [<MODULE> [<MODULE> ..]] Options: @@ -1466,25 +1468,61 @@ Options: + 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) + + hpc combine - 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 change the original .tix file; it generates a new .tix file. -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 Options: --exclude=[PACKAGE:][MODULE] exclude MODULE and/or PACKAGE --include=[PACKAGE:][MODULE] include MODULE and/or PACKAGE --output=FILE output FILE - --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) hpc overlay and hpc draft