[clang][analyzer][doc] Update Clang SA www docs index.html #112833
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-clang-static-analyzer-1 @llvm/pr-subscribers-clang Author: Endre Fülöp (gamesh411) ChangesDownloads and releases sections are removed, users are advised to use the conventional ways of acquiring the analyzer. Full diff: https://github.com/llvm/llvm-project/pull/112833.diff 1 Files Affected:
diff --git a/clang/www/analyzer/index.html b/clang/www/analyzer/index.html
index ea0ed4967ec7cc..ea089fcca23a5d 100644
--- a/clang/www/analyzer/index.html
+++ b/clang/www/analyzer/index.html
@@ -69,48 +69,7 @@
<h1>Clang Static Analyzer</h1>
-<p>The Clang Static Analyzer is a source code analysis tool that finds bugs in
-C, C++, and Objective-C programs.</p>
-
-<p>Currently it can be run either from the <a href="command-line.html">command
- line</a> or if you use macOS then <a href="xcode.html">within Xcode</a>. When
-invoked from the command line, it is intended to be run in tandem with a build
-of a codebase.</p>
-
-<p>The analyzer is 100% open source and is part of the <a
-href="https://clang.llvm.org">Clang</a> project. Like the rest of Clang, the
-analyzer is implemented as a C++ library that can be used by other tools and
-applications.</p>
-
-<h2>Download</h2>
-
-<div style="padding:0px; font-size: 90%">
- <b class="spiffy">
- <b class="spiffy1"><b></b></b>
- <b class="spiffy2"><b></b></b>
- <b class="spiffy3"></b>
- <b class="spiffy4"></b>
- <b class="spiffy5"></b></b>
- <div class="spiffyfg">
- <div style="padding:15px">
- <h3 style="margin:0px;padding:0px">Mac OS X</h3>
- <ul>
- <li>Latest build (10.8+):<br>
- <b><a href="downloads/checker-279.tar.bz2">checker-279.tar.bz2</a></b> (built November 14, 2016)
- </li>
- <li><a href="/release_notes.html">Release notes</a></li>
- <li>This build can be used both from the command line and from within Xcode</li>
- <li><a href="/installation.html">Installation</a> and <a href="/scan-build.html">usage</a></li>
- </ul>
- </div>
- </div>
- <b class="spiffy">
- <b class="spiffy5"></b>
- <b class="spiffy4"></b>
- <b class="spiffy3"></b>
- <b class="spiffy2"><b></b></b>
- <b class="spiffy1"><b></b></b></b>
-</div>
+<!-- Removed the Downloads section -->
<div style="padding:0; margin-top:10px; font-size: 90%">
<b class="spiffy">
@@ -121,10 +80,25 @@ <h3 style="margin:0px;padding:0px">Mac OS X</h3>
<b class="spiffy5"></b></b>
<div class="spiffyfg">
<div style="padding:15px">
- <h3 style="margin:0px;padding:0px">Other Platforms</h3>
- <p>For other platforms, please follow the instructions for <a
- href="/installation#OtherPlatforms">building the analyzer</a> from
- source code.<p>
+ <p>The static analyzer is part of Clang. Please refer to the
+ <a href="https://releases.llvm.org/download.html">LLVM
+ releases page</a> for further instructions.</p>
+
+ <p>The official LLVM releases also include <a href="scan-build.html">scan-build</a>.
+ If you're installing Clang from a different source, such as
+ a Linux package repository, then scan-build may be packaged
+ separately as an individual package, or as part of
+ a "clang tools" package.</p>
+
+ <p>If your IDE is using Clang, it may natively integrate the static analyzer.
+ On macOS, the easiest way to use the static analyzer is to invoke it
+ <a href="https://clang.llvm.org/docs/analyzer/user-docs/UsingWithXCode.html">directly
+ from Xcode</a>.</p>
+
+ <p>Additionally, if you're using <a href="https://clang.llvm.org/extra/clang-tidy/">clang-tidy</a>,
+ you can naturally make the static analyzer run alongside clang-tidy
+ by enabling the <a href="https://clang.llvm.org/extra/clang-tidy/checks/list.html">clang-analyzer</a>
+ checks.</p>
</div>
</div>
<b class="spiffy">
|
whisperity
reviewed
Oct 18, 2024
clang/www/analyzer/index.html
Outdated
| source code.<p> | ||
| <p>The static analyzer is part of Clang. Please refer to the | ||
| <a href="https://releases.llvm.org/download.html">LLVM | ||
| releases page</a> for further instructions.</p> |
There was a problem hiding this comment.
Suggested change
| releases page</a> for further instructions.</p> | |
| download page</a> for further instructions.</p> |
It calls itself the "Download page".
There was a problem hiding this comment.
True, I had the GitHub releases page in mind when I typed this, perhaps.
haoNoQ
reviewed
Oct 20, 2024
clang/www/analyzer/index.html
Outdated
Comment on lines
72
to
83
| <p>The Clang Static Analyzer is a source code analysis tool that finds bugs in | ||
| C, C++, and Objective-C programs.</p> | ||
|
|
||
| <p>Currently it can be run either from the <a href="command-line.html">command | ||
| line</a> or if you use macOS then <a href="xcode.html">within Xcode</a>. When | ||
| invoked from the command line, it is intended to be run in tandem with a build | ||
| of a codebase.</p> | ||
|
|
||
| <p>The analyzer is 100% open source and is part of the <a | ||
| href="https://clang.llvm.org">Clang</a> project. Like the rest of Clang, the | ||
| analyzer is implemented as a C++ library that can be used by other tools and | ||
| applications.</p> |
There was a problem hiding this comment.
The intro part can probably stay? (Except the second paragraph.)
There was a problem hiding this comment.
I have re-added the relevant parts to the introduction part.
The flow of text in the HTML is even more aesthetically pleasing this way 👍
Downloads and releases sections are removed, users are advised to use the conventional ways of acquiring the analyzer.
gamesh411
force-pushed
the
update-clang-analyzer-www-index
branch
from
37703dc to
507d067
Compare
NagyDonat
approved these changes
Oct 24, 2024
Closed
NoumanAmir657
pushed a commit
to NoumanAmir657/llvm-project
that referenced
this pull request
Nov 4, 2024
Downloads and releases sections are removed, users are advised to use the conventional ways of acquiring the analyzer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Downloads and releases sections are removed, users are advised to use the conventional ways of acquiring the analyzer.