commit 8350ef6028860546109cad803875436340636eaa
parent 2045ad7dd09ac856b97af3ec8e3e009d02c889ac
Author: Kyle Milz <kyle@0x30.net>
Date: Wed, 31 Aug 2016 18:30:52 -0600
man: polish wrap
Diffstat:
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/man/citrun-wrap.1 b/man/citrun-wrap.1
@@ -18,10 +18,11 @@
.Os
.Sh NAME
.Nm citrun-wrap
-.Nd instrument a build command
+.Nd enable rewriting on a build command
.Sh SYNOPSIS
.Nm
.Ar build_cmd
+.Op Ar arg1 Ar ... Ar argN
.Sh DESCRIPTION
C It Run uses source code rewriting, also called instrumentation. The only time
rewriting can succeed is at software compilation time.
@@ -35,7 +36,7 @@ An important caveat is that
.Ar build_cmd
must search
.Ev PATH
-when finding compiler executables, which must be one of the following:
+when finding compiler executables, which must be named one of the following:
.Pp
.Bl -bullet -compact
.It
@@ -56,14 +57,13 @@ cc
c++
.El
.Pp
-The warnings and errors from the rewrite tool look indiscernible from the
+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 logged to the
+is sent to a
.Pa citrun.log
file.
-Human readable summaries can be generated by the
-.Xr citrun-check 1
-script.
+Human readable summaries can be generated by
+.Xr citrun-check 1 .
.Pp
Incremental building is supported, but mixing object files created by different
versions of
@@ -72,7 +72,7 @@ is not.
.Sh FILES
.Bl -tag -width Ds
.It Pa citrun.log
-Instrumentation log.
+Rewrite activity log.
.El
.Sh EXIT STATUS
The