From 0d9d024b234d72d3b8d1b631ad3994741c6801c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Endre=20F=C3=BCl=C3=B6p?= 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 ea0ed4967ec7c..ea089fcca23a5 100644 --- a/clang/www/analyzer/index.html +++ b/clang/www/analyzer/index.html @@ -69,48 +69,7 @@

Clang Static Analyzer

-

The Clang Static Analyzer is a source code analysis tool that finds bugs in -C, C++, and Objective-C programs.

- -

Currently it can be run either from the command - line or if you use macOS then within Xcode. When -invoked from the command line, it is intended to be run in tandem with a build -of a codebase.

- -

The analyzer is 100% open source and is part of the Clang project. Like the rest of Clang, the -analyzer is implemented as a C++ library that can be used by other tools and -applications.

- -

Download

- -
- - - - - - -
-
-

Mac OS X

- -
-
- - - - - - -
+
@@ -121,10 +80,25 @@

Mac OS X
-

Other Platforms

-

For other platforms, please follow the instructions for building the analyzer from - source code.

+

The static analyzer is part of Clang. Please refer to the + LLVM + releases page for further instructions.

+ +

The official LLVM releases also include scan-build. + 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.

+ +

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 + directly + from Xcode.

+ +

Additionally, if you're using clang-tidy, + you can naturally make the static analyzer run alongside clang-tidy + by enabling the clang-analyzer + checks.

From 507d06773e8f076b7069aa4b7660123c77008c18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Endre=20F=C3=BCl=C3=B6p?= 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 ea089fcca23a5..736ac4aa0f656 100644 --- a/clang/www/analyzer/index.html +++ b/clang/www/analyzer/index.html @@ -69,7 +69,12 @@

Clang Static Analyzer

- +

The Clang Static Analyzer is a source code analysis tool that finds bugs in +C, C++, and Objective-C programs.

+ +

The analyzer is 100% open source and is part of the Clang +project. Like the rest of Clang, the analyzer is implemented as a C++ library +that can be used by other tools and applications.

@@ -80,12 +85,14 @@

Clang Static Analyzer
-

The static analyzer is part of Clang. Please refer to the + +

To get started with the Clang Static Analyzer, visit the LLVM - releases page for further instructions.

+ releases page for download and installation instructions. The official + releases include both the analyzer and scan-build, + a command-line tool for running the analyzer on your codebase.

-

The official LLVM releases also include scan-build. - If you're installing Clang from a different source, such as +

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.