commit 1c921cd9b7374beb41e427d0f81d22792e89261e
parent 3a5965614c095288985362125edf59f8e431c502
Author: Kyle Milz <kyle@0x30.net>
Date: Thu, 4 Aug 2016 00:01:25 -0600
man: add page for citrun-check
Diffstat:
3 files changed, 49 insertions(+), 5 deletions(-)
diff --git a/man/citrun-check.1 b/man/citrun-check.1
@@ -0,0 +1,40 @@
+.\"
+.\" Copyright (c) 2016 Kyle Milz <kyle@0x30.net>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: August 3 2016 $
+.Dt CITRUN-CHECK 1
+.Os
+.Sh NAME
+.Nm citrun-check
+.Nd check directory for instrumentation
+.Sh SYNOPSIS
+.Nm
+.Op Ar dir
+.Sh DESCRIPTION
+The
+.Nm
+script recursively checks either
+.Ar dir
+or the current working directory for instrumentation activity.
+.Pp
+An instrumentation summary is printed showing detailed counts of important
+events.
+.Pp
+The number of instrumentation failure true positives is an important value. If
+this is ever greater than 0, please send a bug report.
+.Sh EXIT STATUS
+.Ex -std
+.Sh SEE ALSO
+.Xr citrun-wrap 1
diff --git a/man/citrun-wrap.1 b/man/citrun-wrap.1
@@ -44,10 +44,11 @@ gcc / g++
cc / c++
.El
.Pp
-Because instrumentation is silent on stdout and stderr, instrumentation activity
-is logged to the
+Because instrumentation is silent any activity is logged to the
.Pa citrun.log
-file.
+file. Instrumentations summaries can be generated by the
+.Xr citrun-check 1
+script.
.Pp
Incremental building is supported. If the build command fails, fix the problem
and then rerun the build command with
@@ -87,5 +88,6 @@ run:
.Pp
.Dl $ ./program
.Sh SEE ALSO
+.Xr citrun-check 1 ,
.Xr citrun-gl 1 ,
.Xr citrun-term 1
diff --git a/src/Jamfile b/src/Jamfile
@@ -1,10 +1,12 @@
SubDir TOP src ;
#
-# citrun-wrap
+# citrun-wrap, citrun-check
#
MkWrap citrun-wrap : wrap.in ;
-InstallShell $(PREFIX)/bin : citrun-wrap ;
+MakeLocate citrun-check : $(LOCATE_SOURCE) ;
+Shell citrun-check : check.in ;
+InstallShell $(PREFIX)/bin : citrun-wrap citrun-check ;
#
# utils.a
