https://github.com/gamesh411 updated https://github.com/llvm/llvm-project/pull/112833
From 0d9d024b234d72d3b8d1b631ad3994741c6801c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Endre=20F=C3=BCl=C3=B6p?= <endre.fu...@sigmatechnology.com> Date: Thu, 17 Oct 2024 20:21:03 +0200 Subject: [PATCH 1/2] [clang][analyzer][doc] Update Clang SA www docs index.html Downloads and releases sections are removed, users are advised to use the conventional ways of acquiring the analyzer. --- clang/www/analyzer/index.html | 66 +++++++++++------------------------ 1 file changed, 20 insertions(+), 46 deletions(-) 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"> From 507d06773e8f076b7069aa4b7660123c77008c18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Endre=20F=C3=BCl=C3=B6p?= <endre.fu...@sigmatechnology.com> Date: Thu, 24 Oct 2024 17:31:38 +0200 Subject: [PATCH 2/2] update first section to still have the introduction paragraphs --- clang/www/analyzer/index.html | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/clang/www/analyzer/index.html b/clang/www/analyzer/index.html index ea089fcca23a5d..736ac4aa0f6562 100644 --- a/clang/www/analyzer/index.html +++ b/clang/www/analyzer/index.html @@ -69,7 +69,12 @@ <h1>Clang Static Analyzer</h1> -<!-- Removed the Downloads section --> +<p>The Clang Static Analyzer is a source code analysis tool that finds bugs in +C, C++, and Objective-C programs.</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> <div style="padding:0; margin-top:10px; font-size: 90%"> <b class="spiffy"> @@ -80,12 +85,14 @@ <h1>Clang Static Analyzer</h1> <b class="spiffy5"></b></b> <div class="spiffyfg"> <div style="padding:15px"> - <p>The static analyzer is part of Clang. Please refer to the + + <p>To get started with the Clang Static Analyzer, visit the <a href="https://releases.llvm.org/download.html";>LLVM - releases page</a> for further instructions.</p> + releases page</a> for download and installation instructions. The official + releases include both the analyzer and <a href="scan-build.html">scan-build</a>, + a command-line tool for running the analyzer on your codebase.</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 + <p>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> _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
