commit 5e6608eecce5d391ad42e4663a2add822b94ec6b
parent b0900ba5cec1f7b0c6b124f103c5a03b3bd9b6a6
Author: Kyle Milz <kyle@0x30.net>
Date: Wed, 31 Aug 2016 18:31:48 -0600
www: sync man
Diffstat:
3 files changed, 14 insertions(+), 16 deletions(-)
diff --git a/www/man/citrun-check.1.html b/www/man/citrun-check.1.html
@@ -29,7 +29,7 @@ CITRUN-CHECK(1)</td>
</tbody>
</table>
<div class="section">
-<h1 id="NAME">NAME</h1> <b class="name">citrun-check</b> — <span class="desc">check directories for log files</span></div>
+<h1 id="NAME">NAME</h1> <b class="name">citrun-check</b> — <span class="desc">check for rewrite activity</span></div>
<div class="section">
<h1 id="SYNOPSIS">SYNOPSIS</h1><table class="synopsis">
<col style="width: 12.00ex;"/>
@@ -39,17 +39,17 @@ CITRUN-CHECK(1)</td>
<td>
<b class="name">citrun-check</b></td>
<td>
-[<span class="opt"><i class="arg">dir</i></span>]</td>
+[<span class="opt"><b class="flag">-o</b> <i class="arg">output</i></span>] [<span class="opt"><i class="arg">dir</i></span>]</td>
</tr>
</tbody>
</table>
</div>
<div class="section">
-<h1 id="DESCRIPTION">DESCRIPTION</h1> The <b class="name">citrun-check</b> script recursively checks either <i class="arg">dir</i>, if given, or the current working directory for <i class="file">citrun.log</i> files created by the rewrite tool.<div class="spacer">
+<h1 id="DESCRIPTION">DESCRIPTION</h1> The <b class="name">citrun-check</b> utility recursively checks either <i class="arg">dir</i>, if given, or the current working directory for activity logs created by <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a>.<div class="spacer">
</div>
-When <b class="name">citrun-check</b> does not have its stdout redirected it prints a “Checking” line that adds a single period for every file processed.<div class="spacer">
+If the <b class="flag">-o</b> option is specified then <b class="name">citrun-check</b> will write to <i class="arg">output</i> instead of standard output.<div class="spacer">
</div>
-Once checking is complete two sections are printed. The text below shows the output of <b class="name">citrun-check</b> after <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a> had been used to instrument a simple project:<div class="spacer">
+The text below shows the output of <b class="name">citrun-check</b> after <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a> had been used to instrument a simple project:<div class="spacer">
</div>
<pre style="margin-left: 5.00ex;" class="lit display">
Summary:
@@ -66,13 +66,11 @@ Totals:
3 Total statements</pre>
<div class="spacer">
</div>
-The first section is a summary regarding how thoroughly the project was instrumented. The most important counts are in this section.<div class="spacer">
-</div>
-The second section contains rewriting totals. These are the total number of visited source code elements from the source files used as input.</div>
+The first section shows how thoroughly the project was instrumented, while the second section contains rewriting totals.</div>
<div class="section">
-<h1 id="SUMMARY_COUNTS">SUMMARY COUNTS</h1> The most important counts are failures. Source rewriting can fail for a few reasons and is not always a bad thing.<div class="spacer">
+<h1 id="SUMMARY_COUNTS">SUMMARY COUNTS</h1> The most important summary events are failures. Source rewriting can fail for a few reasons and is not always a bad thing.<div class="spacer">
</div>
-The following table shows all of the possible counts, and describes them:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
+The following table lists all possible events and describes them:<dl style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-tag">
<dt class="list-tag" style="margin-top: 1.00em;">
“Source files used as input”</dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
diff --git a/www/man/citrun-inst.1.html b/www/man/citrun-inst.1.html
@@ -55,7 +55,7 @@ The <b class="name">citrun-inst</b> utility performs source code rewriting. It v
</div>
Calling directly is useful for debugging rewrite failures and rewritten source compile failures.<div class="spacer">
</div>
-In this mode, successfully rewritten source files have “.citrun” appended to their file name and diagnostic information is printed to standard output instead of <i class="file">citrun.log</i>.</div>
+In this mode, successfully rewritten source files have “.citrun” appended to their file name and diagnostic information is printed to both standard output and <i class="file">citrun.log</i>.</div>
<div class="section">
<h1 id="EXIT_STATUS">EXIT STATUS</h1> The <b class="utility">citrun-inst</b> utility exits 0 on success, and >0 if an error occurs.</div>
<div class="section">
diff --git a/www/man/citrun-wrap.1.html b/www/man/citrun-wrap.1.html
@@ -29,7 +29,7 @@ CITRUN-WRAP(1)</td>
</tbody>
</table>
<div class="section">
-<h1 id="NAME">NAME</h1> <b class="name">citrun-wrap</b> — <span class="desc">instrument a build command</span></div>
+<h1 id="NAME">NAME</h1> <b class="name">citrun-wrap</b> — <span class="desc">enable rewriting on a build command</span></div>
<div class="section">
<h1 id="SYNOPSIS">SYNOPSIS</h1><table class="synopsis">
<col style="width: 11.00ex;"/>
@@ -39,7 +39,7 @@ CITRUN-WRAP(1)</td>
<td>
<b class="name">citrun-wrap</b></td>
<td>
-<i class="arg">build_cmd</i></td>
+<i class="arg">build_cmd</i> [<span class="opt"><i class="arg">arg1</i> <i class="arg">...</i> <i class="arg">argN</i></span>]</td>
</tr>
</tbody>
</table>
@@ -49,7 +49,7 @@ CITRUN-WRAP(1)</td>
</div>
The <b class="name">citrun-wrap</b> utility enables rewriting on any source files compiled by <i class="arg">build_cmd</i>.<div class="spacer">
</div>
-An important caveat is that <i class="arg">build_cmd</i> must search <span class="env">PATH</span> when finding compiler executables, which must be one of the following:<div class="spacer">
+An important caveat is that <i class="arg">build_cmd</i> must search <span class="env">PATH</span> when finding compiler executables, which must be named one of the following:<div class="spacer">
</div>
<ul style="margin-top: 0.00em;margin-bottom: 0.00em;" class="list list-bul">
<li class="list-bul" style="margin-top: 0.00em;">
@@ -71,7 +71,7 @@ c++</li>
</ul>
<div class="spacer">
</div>
-The warnings and errors from the rewrite tool look indiscernible from the warnings and errors generated by the native compiler, so all rewriting activity is logged to the <i class="file">citrun.log</i> file. Human readable summaries can be generated by the <a class="link-man" href="citrun-check.1.html">citrun-check(1)</a> script.<div class="spacer">
+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 <i class="file">citrun.log</i> file. Human readable summaries can be generated by <a class="link-man" href="citrun-check.1.html">citrun-check(1)</a>.<div class="spacer">
</div>
Incremental building is supported, but mixing object files created by different versions of <b class="name">citrun-wrap</b> is not.</div>
<div class="section">
@@ -79,7 +79,7 @@ Incremental building is supported, but mixing object files created by different
<dt class="list-tag" style="margin-top: 1.00em;">
<i class="file">citrun.log</i></dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
-Instrumentation log.</dd>
+Rewrite activity log.</dd>
</dl>
</div>
<div class="section">
