commit e199113a22a8a7dff08809d5e7f7e098d84c723a parent b9e2722b11b28d5304bcadd9211fa6b89ee69e81 Author: Kyle Milz <kyle@0x30.net> Date: Thu, 4 Aug 2016 19:35:58 -0600 man/check: add example output Diffstat:
M | man/citrun-check.1 | | | 25 | +++++++++++++++++++------ |
1 file changed, 19 insertions(+), 6 deletions(-)
diff --git a/man/citrun-check.1 b/man/citrun-check.1 @@ -18,7 +18,7 @@ .Os .Sh NAME .Nm citrun-check -.Nd check directory for instrumentation +.Nd check directories for instrumentation artifacts .Sh SYNOPSIS .Nm .Op Ar dir @@ -27,13 +27,26 @@ The .Nm script recursively checks either .Ar dir -or the current working directory for instrumentation activity. +or the current working directory for instrumentation artifacts. .Pp -An instrumentation summary is printed showing detailed counts of important -events. +A summary is printed showing detailed counts of important events. The following +is an example of what the output looks like: +.Bd -literal -offset indent +Checking '/usr/ports/pobj/spidermonkey-24.2.0/'... + 3 Log files found + 185 Calls to the instrumentation tool + 117 Forked compilers + 97 Instrumentation successes + 19 Instrumentation failures (false positive) + 1 Instrumentation failures (true positive) + 60 Application link commands +.Ed .Pp -The number of instrumentation failure true positives is an important value. If -this is ever greater than 0, please send a bug report. +The value of +.Qq Instrumentation failures (true positives) +is important. If +this value is ever more than 0 it means that instrumentation failed but a native +compile of the same source succeeded. .Sh EXIT STATUS .Ex -std .Sh SEE ALSO