Skip to content

Commit

Permalink
+ "For Windows Users" section
Browse files Browse the repository at this point in the history
+ description for --use-analyzer option
+ managed size of columns of the 'options' table

llvm-svn: 185199
  • Loading branch information
ayartsev7 committed Jun 28, 2013
1 parent b17b1cd commit 93e5a02
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
5 changes: 4 additions & 1 deletion clang/www/analyzer/content.css
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,17 @@ table.options thead {
text-align:left;
border-top: 2px solid #cccccc;
border-bottom: 2px solid #cccccc;
font-weight: bold; font-family: Verdana
font-weight: bold; font-family: Verdana;
table-layout: fixed;
width: 100%
}
table.options { border: 1px #cccccc solid }
table.options { border-collapse: collapse; border-spacing: 0px }
table.options { margin-left:0px; margin-top:20px; margin-bottom:20px }
table.options td { border-bottom: 1px #cccccc dotted }
table.options td { padding:5px; padding-left:8px; padding-right:8px }
table.options td { text-align:left; font-size:9pt }
table.options col.option { width:207px }

table.checkers {
border: 1px #cccccc solid;
Expand Down
18 changes: 17 additions & 1 deletion clang/www/analyzer/scan-build.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ <h2>Contents</h2>
<li><a href="#scanbuild">Getting Started</a>
<ul>
<li><a href="#scanbuild_basicusage">Basic Usage</a></li>
<li><a href="#scanbuild_forwindowsusers">For Windows Users</a></li>
<li><a href="#scanbuild_otheroptions">Other Options</a></li>
<li><a href="#scanbuild_output">Output of scan-build</a></li>
</ul>
Expand Down Expand Up @@ -122,6 +123,14 @@ <h3 id="scanbuild_basicusage">Basic Usage</h3>
<p>This example causes the files <tt>t1.c</tt> and <tt>t2.c</tt> to be analyzed.
</p>

<h3 id="scanbuild_forwindowsusers">For Windows Users</h3>

<p>Windows users must have Perl installed to use scan-build. Currently scan-build
is known to work with the msys perl port.</p>

<p>scan-build.bat script allows you to launch scan-build in the same way as it described in the Basic Usage section above.
All you need to be able to invoke scan-build from an arbitrary location is to add the path to scan-build to your PATH environment variable.</p>

<h3 id="scanbuild_otheroptions">Other Options</h3>

<p>As mentioned above, extra options can be passed to <tt>scan-build</tt>. These
Expand All @@ -135,6 +144,7 @@ <h3 id="scanbuild_otheroptions">Other Options</h3>
<p>Here is a subset of useful options:</p>

<table class="options">
<colgroup><col class="option"><col class="description"></colgroup>
<thead><tr><td>Option</td><td>Description</td></tr></thead>

<tr><td><b>-o</b></td><td>Target directory for HTML report files. Subdirectories
Expand All @@ -155,7 +165,13 @@ <h3 id="scanbuild_otheroptions">Other Options</h3>
reports against the analyzer.</td></tr>

<tr><td><b>-V</b></td><td>View analysis results in a web browser when the build
command completes.</td></tr> </table>
command completes.</td></tr>

<tr><td><b>--use-analyzer Xcode</b><br><i>or</i><br>
<b>--use-analyzer [path to clang]</b></td><td><tt>scan-build</tt> uses the
'clang' executable relative to itself for static analysis. One can override this
behavior with this option by using the 'clang' packaged with Xcode (on OS X) or
from the PATH.</p></td></tr> </table>

<p>A complete list of options can be obtained by running <tt>scan-build</tt>
with no arguments.</p>
Expand Down

0 comments on commit 93e5a02

Please sign in to comment.