commit eba5fca53d35bc2a1ac36df9fb67f4d2958743e7
parent 163251d67f26add67cdd2ed754b0f0a578cdcf91
Author: kyle <kyle@0x30.net>
Date: Thu, 19 Jan 2017 00:05:13 -0700
wrap: freshen man page
Diffstat:
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/citrun_wrap.1 b/citrun_wrap.1
@@ -18,25 +18,28 @@
.Os
.Sh NAME
.Nm citrun_wrap
-.Nd enable rewriting on a build command
+.Nd enable C It Run on a build command
.Sh SYNOPSIS
.Nm
.Ar build_cmd
.Op Ar ...
.Sh DESCRIPTION
-C It Run must rewrite source code to add instrumentation. This process happens
-at compile time.
+Special information must be added to a programs source code in order to see it
+run.
.Pp
The
.Nm
utility enables source code rewriting on any files compiled during
.Ar build_cmd .
+Ideally
+.Ar build_cmd
+is the top level build command.
.Pp
-An important caveat is that
+The given
.Ar build_cmd
must search
.Ev PATH
-when finding compiler executables, which must be named one of the following:
+when finding compiler binaries that must be one of the following:
.Pp
.Bl -bullet -compact
.It
@@ -57,18 +60,15 @@ g++
gcc
.El
.Pp
-The warnings and errors from the rewrite tool are indiscernible from the
-warnings and errors generated by the native compiler, so all rewriting activity
-is sent to a
+All rewriting activity is written to
.Pa citrun.log
-file.
-Human readable summaries can be generated by
+files and human readable summaries can be generated from them with
.Xr citrun_check 1 .
.Pp
-Incremental building is supported, but mixing object files created by different
-versions of
+Incremental building is supported by
.Nm
-is not.
+but mixing object files created by different
+versions of C It Run is not.
.Sh FILES
.Bl -tag -width Ds
.It Pa citrun.log
@@ -94,7 +94,7 @@ built with make and make searches PATH for gcc
.Pp
Prepending
.Nm
-to the projects build command adds instrumentation:
+to the build command adds instrumentation:
.Pp
.Dl $ citrun_wrap make
.Pp
