Skip to content

Commit 8263b3b

Browse files
gamesh411gamesh411
committed
add redirect pages
1 parent e191d14 commit 8263b3b

File tree

6 files changed

+56
-725
lines changed

6 files changed

+56
-725
lines changed

‎clang/www/analyzer/codechecker.html‎

Lines changed: 10 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"http://www.w3.org/TR/html4/strict.dtd">
33
<html>
44
<head>
5-
<title>CodeChecker: running the analyzer from the command line</title>
5+
<title>The CodeChecker documentation has moved to clang.llvm.org</title>
6+
<link rel="canonical" href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#codechecker"/>
7+
<meta http-equiv="refresh" content="0;url=https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#codechecker" />
68
<link type="text/css" rel="stylesheet" href="content.css">
79
<link type="text/css" rel="stylesheet" href="menu.css">
810
<script type="text/javascript" src="scripts/menu.js"></script>
@@ -13,61 +15,11 @@
1315
<!--#include virtual="menu.html.incl"-->
1416
<div id="content">
1517

16-
<h1>CodeChecker: running the analyzer from the command line</h1>
18+
<h1>The Codechecker documentation has moved to clang.llvm.org</h1>
19+
<p style="color:red; font-size:200%">This page is deprecated and will be removed in release 21.0</p>
20+
<a href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#codechecker">The new site</a>
21+
<script>window.location='https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html#codechecker'</script>
1722

18-
<h2>Basic Usage</h2>
19-
20-
<p>
21-
Install CodeChecker as described here: <a href="https://github.com/Ericsson/codechecker/#Install-guide"> CodeChecker Install Guide.</a>
22-
</p>
23-
24-
<p>
25-
Create a compilation database. If you use cmake then pass the <tt>-DCMAKE_EXPORT_COMPILE_COMMANDS=1</tt> parameter to cmake. Cmake will create a <tt>compile_commands.json</tt> file.
26-
If you have a Makefile based or similar build system then you can log the build commands with the help of CodeChecker:
27-
<pre class="code_example">
28-
make clean
29-
CodeChecker log -b "make" -o compile_commands.json
30-
</pre>
31-
</p>
32-
33-
<p>
34-
Analyze your project.
35-
<pre class="code_example">
36-
CodeChecker analyze compile_commands.json -o ./reports
37-
</pre>
38-
</p>
39-
40-
<p>
41-
View the analysis results.
42-
Print the detailed results in the command line:
43-
<pre class="code_example">
44-
CodeChecker parse --print-steps ./reports
45-
</pre>
46-
Or view the detailed results in a browser:
47-
<pre class="code_example">
48-
CodeChecker parse ./reports -e html -o ./reports_html
49-
firefox ./reports_html/index.html
50-
</pre>
51-
</p>
52-
53-
<p>
54-
Optional: store the analysis results in a DB.
55-
<pre class="code_example">
56-
mkdir ./ws
57-
CodeChecker server -w ./ws -v 8555 &
58-
CodeChecker store ./reports --name my-project --url http://localhost:8555/Default
59-
</pre>
60-
</p>
61-
62-
<p>
63-
Optional: manage (categorize, suppress) the results in your web browser:
64-
<pre class="code_example">
65-
firefox http://localhost:8555/Default
66-
</pre>
67-
</p>
68-
69-
<h2>Detailed Usage</h2>
70-
71-
<p>
72-
For extended documentation please refer to the <a href="https://github.com/Ericsson/codechecker/blob/master/docs/usage.md">official site of CodeChecker</a>!
73-
</p>
23+
</div> <!-- content -->
24+
</div> <!-- page -->
25+
</body>

‎clang/www/analyzer/command-line.html‎

Lines changed: 10 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"http://www.w3.org/TR/html4/strict.dtd">
33
<html>
44
<head>
5-
<title>Running the analyzer from the command line</title>
5+
<title>The command line documentation has moved to clang.llvm.org</title>
6+
<link rel="canonical" href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html"/>
7+
<meta http-equiv="refresh" content="0;url=https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html" />
68
<link type="text/css" rel="stylesheet" href="content.css">
79
<link type="text/css" rel="stylesheet" href="menu.css">
810
<script type="text/javascript" src="scripts/menu.js"></script>
@@ -13,55 +15,12 @@
1315
<!--#include virtual="menu.html.incl"-->
1416
<div id="content">
1517

16-
<h1>Running the analyzer from the command line</h1>
18+
<h1>The command line documentation has moved to clang.llvm.org</h1>
19+
<p style="color:red; font-size:200%">This page is deprecated and will be removed in release 21.0</p>
20+
<a href="https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html">The new site</a>
21+
<script>window.location='https://clang.llvm.org/docs/analyzer/user-docs/CommandLineUsage.html'</script>
1722

18-
<p> Static Analyzer is by design a GUI tool. Its purpose is to find buggy execution
19-
paths in the program, and such paths are very hard to comprehend by looking at
20-
a non-interactive standard output. It is possible, however, to invoke the
21-
Static Analyzer from the command line in order to obtain analysis results, and
22-
then later view them interactively in a graphical interface. The following
23-
tools are used commonly to run the analyzer from the command line. Both tools
24-
are wrapper scripts to drive the analysis and the underlying invocations of the
25-
Clang compiler:
26-
<ol>
27-
<li><a href="scan-build.html">Scan-Build</a>
28-
is an old and simple command-line tool that emits static analyzer warnings as HTML files while compiling your project. You can view the analysis results in your web browser.
29-
</li>
30-
<ul>
31-
<li>
32-
Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment.
33-
</li>
34-
<li>
35-
Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions.
36-
</li>
37-
<li>
38-
Does not include support for cross-translation-unit analysis.
39-
</li>
40-
</ul>
41-
<li><a href="codechecker.html">CodeChecker</a>
42-
is a web server that runs the Static Analyzer on your projects on demand and maintains a database of issues.
43-
</li>
44-
<ul>
45-
<li>
46-
Perfect for managing large amounts of Static Analyzer warnings in a collaborative environment.
47-
</li>
48-
<li>
49-
Generally much more feature-rich than scan-build.
50-
</li>
51-
<li>Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects.</li>
52-
<li><a href="https://clang.llvm.org/docs/analyzer/user-docs/CrossTranslationUnit.html">Cross Translation Unit (CTU) analysis</a> is supported fully on Linux via CodeChecker.</li>
53-
<li>Can run clang-tidy checkers too.</li>
54-
<li>Open source, but out-of-tree, i.e. not part of the LLVM project.</li>
55-
</ul>
56-
</ol>
57-
</p>
58-
59-
<p>
60-
</p>
61-
<p>
62-
</p>
63-
64-
</div>
65-
</div>
23+
</div> <!-- content -->
24+
</div> <!-- page -->
6625
</body>
67-
</html>
26+

‎clang/www/analyzer/filing_bugs.html‎

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
"http://www.w3.org/TR/html4/strict.dtd">
33
<html>
44
<head>
5+
<title>The filing bugs documentation has moved to clang.llvm.org</title>
6+
<link rel="canonical" href="https://clang.llvm.org/docs/analyzer/user-docs/FilingBugs.html"/>
7+
<meta http-equiv="refresh" content="0;url=https://clang.llvm.org/docs/analyzer/user-docs/FilingBugs.html" />
58
<meta charset="UTF-8">
6-
<title>Filing Bugs and Feature Requests</title>
79
<link type="text/css" rel="stylesheet" href="menu.css">
810
<link type="text/css" rel="stylesheet" href="content.css">
911
<script type="text/javascript" src="scripts/menu.js"></script>
@@ -14,32 +16,11 @@
1416
<!--#include virtual="menu.html.incl"-->
1517
<div id="content">
1618

17-
<h1>Filing Bugs and Feature Requests</h1>
19+
<h1>The filing bugs documentation has moved to clang.llvm.org</h1>
20+
<p style="color:red; font-size:200%">This page is deprecated and will be removed in release 21.0</p>
21+
<a href="https://clang.llvm.org/docs/analyzer/user-docs/FilingBugs.html">The new site</a>
22+
<script>window.location='https://clang.llvm.org/docs/analyzer/user-docs/FilingBugs.html'</script>
1823

19-
<p>We encourage users to file bug reports for any problems that they encounter.
20-
We also welcome feature requests. When filing a bug report, please do the
21-
following:</p>
22-
23-
<ul>
24-
25-
<li>Include the checker build (for prebuilt Mac OS X binaries) or the git hash.
26-
</li>
27-
28-
<li>Provide a self-contained, reduced test case that exhibits the issue you are
29-
experiencing.</li>
30-
31-
<li>Test cases don't tell us everything. Please briefly describe the problem you
32-
are seeing, including what you thought should have been the expected behavior
33-
and why.</li>
34-
35-
</ul>
36-
37-
<p>Please <a href="https://llvm.org/docs/HowToSubmitABug.html">file
38-
bugs and feature requests</a> in
39-
<a href="https://github.com/llvm/llvm-project/issues">LLVM's issue tracker</a>
40-
and label the report with the <code>clang:static analyzer</code> label.</p>
41-
42-
</div>
43-
</div>
24+
</div> <!-- content -->
25+
</div> <!-- page -->
4426
</body>
45-
</html>

‎clang/www/analyzer/installation.html‎

Lines changed: 9 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
"http://www.w3.org/TR/html4/strict.dtd">
33
<html>
44
<head>
5-
<title>Obtaining the Static Analyzer</title>
5+
<title>The installation documentation has moved to clang.llvm.org</title>
6+
<link rel="canonical" href="https://clang.llvm.org/docs/analyzer/user-docs/Installation.html"/>
7+
<meta http-equiv="refresh" content="0;url=https://clang.llvm.org/docs/analyzer/user-docs/Installation.html" />
68
<link type="text/css" rel="stylesheet" href="menu.css">
79
<link type="text/css" rel="stylesheet" href="content.css">
810
<script type="text/javascript" src="scripts/menu.js"></script>
@@ -13,98 +15,11 @@
1315
<!--#include virtual="menu.html.incl"-->
1416
<div id="content">
1517

16-
<h1>Obtaining the Static Analyzer</h1>
18+
<h1>The installation documentation has moved to clang.llvm.org</h1>
19+
<p style="color:red; font-size:200%">This page is deprecated and will be removed in release 21.0</p>
20+
<a href="https://clang.llvm.org/docs/analyzer/user-docs/Installation.html">The new site</a>
21+
<script>window.location='https://clang.llvm.org/docs/analyzer/user-docs/Installation.html'</script>
1722

18-
<p>This page describes how to download and install the analyzer. Once
19-
the analyzer is installed, follow the <a
20-
href="/scan-build.html">instructions</a> on using <tt>scan-build</tt> to
21-
get started analyzing your code.</p>
22-
23-
<h2>Packaged Builds (Mac OS X)</h2>
24-
25-
<p>Semi-regular pre-built binaries of the analyzer are available on Mac
26-
OS X. These are built to run on OS X 10.7 and later.</p>
27-
28-
<p>Builds are released frequently. Often the differences between build
29-
numbers being a few bug fixes or minor feature improvements. When using
30-
the analyzer, we recommend that you check back here occasionally for new
31-
builds, especially if the build you are using is more than a couple
32-
weeks old.</p>
33-
34-
<p>The latest build is:
35-
<!--#include virtual="latest_checker.html.incl"-->
36-
</p>
37-
38-
<p>Packaged builds for other platforms may eventually be provided, but
39-
we need volunteers who are willing to help provide such regular builds.
40-
If you wish to help contribute regular builds of the analyzer on other
41-
platforms, please email the <a
42-
href="https://lists.llvm.org/mailman/listinfo/cfe-dev">Clang
43-
Developers' mailing list</a>.</p>
44-
45-
<h3>Using Packaged Builds</h3>
46-
47-
<p>To use a package build, simply unpack it anywhere. If the build
48-
archive has the name <b><tt>checker-XXX.tar.bz2</tt></b> then the
49-
archive will expand to a directory called <b><tt>checker-XXX</tt></b>.
50-
You do not need to place this directory or the contents of this
51-
directory in any special place. Uninstalling the analyzer is as simple
52-
as deleting this directory.</p>
53-
54-
<p>Most of the files in the <b><tt>checker-XXX</tt></b> directory will
55-
be supporting files for the analyzer that you can simply ignore. Most
56-
users will only care about two files, which are located at the top of
57-
the <b><tt>checker-XXX</tt></b> directory:</p>
58-
59-
<ul>
60-
<li><b>scan-build</b>: <tt>scan-build</tt> is the high-level command line utility for running the analyzer</li>
61-
<li><b>scan-view</b>: <tt>scan-view</tt> a companion command line
62-
utility to <tt>scan-build</tt>, <tt>scan-view</tt> is used to view
63-
analysis results generated by <tt>scan-build</tt>. There is an option
64-
that one can pass to <tt>scan-build</tt> to cause <tt>scan-view</tt> to
65-
run as soon as it the analysis of a build completes</li>
66-
</ul>
67-
68-
<h4>Running scan-build</h4>
69-
70-
<p>For specific details on using <tt>scan-build</tt>, please see
71-
<tt>scan-build</tt>'s <a href="/scan-build">documentation</a>.</p>
72-
73-
<p>To run <tt>scan-build</tt>, either add the
74-
<b><tt>checker-XXX</tt></b> directory to your path or specify a complete
75-
path for <tt>scan-build</tt> when running it. It is also possible to use
76-
a symbolic link to <tt>scan-build</tt>, such one located in a directory
77-
in your path. When <tt>scan-build</tt> runs it will automatically
78-
determine where to find its accompanying files.</p>
79-
80-
<h2 id="OtherPlatforms">Other Platforms (Building the Analyzer from Source)</h2>
81-
82-
<p>For other platforms, you must build Clang and LLVM manually. To do
83-
so, please follow the instructions for <a
84-
href="https://clang.llvm.org/get_started.html#build">building Clang from
85-
source code</a>.<p>
86-
87-
<p>Once the Clang is built, you need to add the following to your path:</p>
88-
89-
<ul>
90-
91-
<li>The location of the <tt>clang</tt> binary.
92-
93-
<p>For example, if you built a <em>Debug+Asserts</em> build of LLVM/Clang (the
94-
default), the resultant <tt>clang</tt> binary will be in <tt>$(OBJDIR)/Debug+Asserts/bin</tt>
95-
(where <tt>$(OBJDIR)</tt> is often the same as the root source directory). You
96-
can also do <tt>make install</tt> to install the LLVM/Clang libraries and
97-
binaries to the installation directory of your choice (specified when you run
98-
<tt>configure</tt>).</p></li>
99-
100-
<li>The locations of the <tt>scan-build</tt> and <tt>scan-view</tt>
101-
programs.
102-
103-
<p>These are installed via <tt>make install</tt> into the bin directory
104-
when clang is built.</p></li>
105-
106-
</ul>
107-
</div>
108-
</div>
23+
</div> <!-- content -->
24+
</div> <!-- page -->
10925
</body>
110-
</html>

0 commit comments

Comments
 (0)