commit 24cf38d17a7b87cbfcea0b94a95748a79c14811e
parent 0974d5f8fabb09febfd4d76633aaa3fd5a4408b3
Author: Kyle Milz <kyle@0x30.net>
Date: Sun, 21 Aug 2016 12:48:01 -0600
www: sync
Diffstat:
4 files changed, 79 insertions(+), 7 deletions(-)
diff --git a/www/index.html b/www/index.html
@@ -34,12 +34,13 @@
</ul>
<h2>Documentation</h2>
- <p>Start with citrun-wrap:
+ <p>This is in order of most important to least important:
</p>
<ul>
<li><a href="man/citrun-wrap.1.html">citrun-wrap(1)</a>
<li><a href="man/citrun-check.1.html">citrun-check(1)</a>
<li><a href="man/citrun-term.1.html">citrun-term(1)</a>
+ <li><a href="man/citrun-inst.1.html">citrun-inst(1)</a>
</ul>
</body>
diff --git a/www/man/citrun-check.1.html b/www/man/citrun-check.1.html
@@ -53,7 +53,6 @@ Once checking is complete two sections are printed. The text below shows the out
</div>
<pre style="margin-left: 5.00ex;" class="lit display">
Summary:
- 1 Calls to the rewrite tool
1 Source files used as input
1 Application link commands
1 Rewrite successes
@@ -75,10 +74,6 @@ The second section contains rewriting totals. These are the total number of visi
</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">
<dt class="list-tag" style="margin-top: 1.00em;">
-“Calls to the rewrite tool”</dt>
-<dd class="list-tag" style="margin-left: 6.00ex;">
-The total number of times <a class="link-man" href="citrun-inst.1.html">citrun-inst(1)</a> was called.</dd>
-<dt class="list-tag" style="margin-top: 1.00em;">
“Source files used as input”</dt>
<dd class="list-tag" style="margin-left: 6.00ex;">
The total number of C/C++ source files that had rewriting attempted on them.</dd>
diff --git a/www/man/citrun-inst.1.html b/www/man/citrun-inst.1.html
@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8"/>
+<style>
+table.head, table.foot { width: 100%; }
+td.head-rtitle, td.foot-os { text-align: right; }
+td.head-vol { text-align: center; }
+table.foot td { width: 50%; }
+table.head td { width: 33%; }
+div.spacer { margin: 1em 0; }
+</style>
+<link rel="stylesheet" href="/citrun.css" type="text/css" media="all"/>
+<title>
+CITRUN-INST(1)</title>
+</head>
+<body>
+<div class="mandoc">
+<table class="head">
+<tbody>
+<tr>
+<td class="head-ltitle">
+CITRUN-INST(1)</td>
+<td class="head-vol">
+General Commands Manual</td>
+<td class="head-rtitle">
+CITRUN-INST(1)</td>
+</tr>
+</tbody>
+</table>
+<div class="section">
+<h1 id="NAME">NAME</h1> <b class="name">citrun-inst</b> — <span class="desc">rewrite source code</span></div>
+<div class="section">
+<h1 id="SYNOPSIS">SYNOPSIS</h1><table class="synopsis">
+<col style="width: 11.00ex;"/>
+<col/>
+<tbody>
+<tr>
+<td>
+<b class="name">citrun-inst</b></td>
+<td>
+<i class="arg">compile_cmd</i></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section">
+<h1 id="DESCRIPTION">DESCRIPTION</h1> Warning: <b class="name">citrun-inst</b> is not usually called directly. Use <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a> instead.<div class="spacer">
+</div>
+The <b class="name">citrun-inst</b> utility performs source code rewriting. It visits statements in source files and adds extra code to some of them.<div class="spacer">
+</div>
+<b class="name">citrun-inst</b> should accept any <i class="arg">compile_cmd</i> that the compilers listed in <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a> would accept.</div>
+<div class="section">
+<h1 id="CALLING_DIRECTLY">CALLING DIRECTLY</h1> When <b class="name">citrun-inst</b> is called directly it only performs its source code rewriting step. That means it does not perform its usual call to compile the (possibly) rewritten source file.<div class="spacer">
+</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>
+<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">
+<h1 id="SEE_ALSO">SEE ALSO</h1> <a class="link-man" href="citrun-wrap.1.html">citrun-wrap(1)</a></div>
+<table class="foot">
+<tbody>
+<tr>
+<td class="foot-date">
+August 13, 2016</td>
+<td class="foot-os">
+OpenBSD 6.0</td>
+</tr>
+</tbody>
+</table>
+</div>
+</body>
+</html>
+
diff --git a/www/man/citrun-wrap.1.html b/www/man/citrun-wrap.1.html
@@ -71,7 +71,7 @@ c++</li>
</ul>
<div class="spacer">
</div>
-Because the warnings and errors from the rewrite tool will look indiscernible from the warnings and errors generated by the native compiler, 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 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">
</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">
