Author: Donát Nagy Date: 2025-11-27T14:22:59+01:00 New Revision: 514dbab474c71326c1080f3129a26f0ffdd71d51
URL: https://github.com/llvm/llvm-project/commit/514dbab474c71326c1080f3129a26f0ffdd71d51 DIFF: https://github.com/llvm/llvm-project/commit/514dbab474c71326c1080f3129a26f0ffdd71d51.diff LOG: [NFC][analyzer] Clean up obsolete installation instructions (#166193) The documentation file `Installation.rst` contained very obsolete instructions for installing the clang static analyzer. This commit replaces it with sentence which explains that the analyzer is part of clang and links to the releases page of LLVM (for downloading clang). This sentence is primarily added to the top-level page of the analyzer documentation; but it also appears in a stubbed Installation.rst (for users who followed a direct external link to this installation page). This stubbed section is removed from the table of contents, but I kept it as an orphaned page (to avoid breaking links). Fixes #165571 Added: Modified: clang/docs/ClangStaticAnalyzer.rst clang/docs/analyzer/user-docs.rst clang/docs/analyzer/user-docs/CommandLineUsage.rst clang/docs/analyzer/user-docs/Installation.rst Removed: ################################################################################ diff --git a/clang/docs/ClangStaticAnalyzer.rst b/clang/docs/ClangStaticAnalyzer.rst index 7a309dc4acd91..9ab485f6800f8 100644 --- a/clang/docs/ClangStaticAnalyzer.rst +++ b/clang/docs/ClangStaticAnalyzer.rst @@ -5,9 +5,9 @@ Clang Static Analyzer The Clang Static Analyzer is a source code analysis tool that finds bugs in C, C++, and Objective-C programs. It implements *path-sensitive*, *inter-procedural analysis* based on *symbolic execution* technique. -This is the Static Analyzer documentation page. +The Static Analyzer is a part of Clang; for downloading and installing Clang visit the `LLVM releases page <https://releases.llvm.org/>`_. -See the `Official Tool Page <https://clang-analyzer.llvm.org/>`_. +This is the documentation page of the Static Analyzer; there is also an old `Official Tool Page <https://clang-analyzer.llvm.org/>`_ which provides a short overview of features and limitations. .. toctree:: :caption: Table of Contents diff --git a/clang/docs/analyzer/user-docs.rst b/clang/docs/analyzer/user-docs.rst index 67c1dfaa40965..1ea193b1a651b 100644 --- a/clang/docs/analyzer/user-docs.rst +++ b/clang/docs/analyzer/user-docs.rst @@ -6,7 +6,6 @@ Contents: .. toctree:: :maxdepth: 2 - user-docs/Installation user-docs/CommandLineUsage user-docs/Options user-docs/UsingWithXCode diff --git a/clang/docs/analyzer/user-docs/CommandLineUsage.rst b/clang/docs/analyzer/user-docs/CommandLineUsage.rst index 0252de80b788f..089a8ce68ce0a 100644 --- a/clang/docs/analyzer/user-docs/CommandLineUsage.rst +++ b/clang/docs/analyzer/user-docs/CommandLineUsage.rst @@ -16,18 +16,19 @@ It is possible, however, to invoke the static analyzer from the command line in The following tools are used commonly to run the analyzer from the command line. Both tools are wrapper scripts to drive the analysis and the underlying invocations of the Clang compiler: -1. scan-build_ 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. +1. scan-build_ 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; the utility script ``scan-view`` can provide a trivial HTTP server that servers these result files. + - Is available as a part of the LLVM project (together with ``scan-view``). - Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment. - Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions. - Does not include support for cross-translation-unit analysis. 2. CodeChecker_ is a driver and web server that runs the static analyzer on your projects on demand and maintains a database of issues. + - Open source, but out-of-tree, i.e. not part of the LLVM project. - Perfect for managing large amounts of thee static analyzer warnings in a collaborative environment. - Generally much more feature-rich than scan-build. - Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects. - :doc:`CrossTranslationUnit` is supported fully on Linux via CodeChecker. - - Can run clang-tidy checkers too. - - Open source, but out-of-tree, i.e. not part of the LLVM project. + - Can also run clang-tidy checks and various other analysis tools. scan-build ---------- diff --git a/clang/docs/analyzer/user-docs/Installation.rst b/clang/docs/analyzer/user-docs/Installation.rst index d84007328e5dc..8d2b3aca6e474 100644 --- a/clang/docs/analyzer/user-docs/Installation.rst +++ b/clang/docs/analyzer/user-docs/Installation.rst @@ -1,37 +1,6 @@ +:orphan: + Obtaining the Static Analyzer ============================= -This page describes how to download and install the analyzer. Once the analyzer is installed, follow the :doc:`CommandLineUsage` on using the command line to get started analyzing your code. - -.. contents:: - :local: - - -Building the Analyzer from Source ---------------------------------- - -Currently there are no officially supported binary distributions for the static analyzer. -You must build Clang and LLVM manually. -To do so, please follow the instructions for `building Clang from source code <https://clang.llvm.org/get_started.html#build>`_. - -Once the Clang is built, you need to add the location of the ``clang`` binary and the locations of the command line utilities (`CodeChecker` or ``scan-build`` and ``scan-view``) to you PATH for :doc:`CommandLineUsage`. - -[Legacy] Packaged Builds (Mac OS X) ------------------------------------ - -Semi-regular pre-built binaries of the analyzer used to be available on Mac OS X. These were built to run on OS X 10.7 and later. - -For older builds for MacOS visit https://clang-analyzer.llvm.org/release_notes.html. - -Packaged builds for other platforms may eventually be provided, but we need volunteers who are willing to help provide such regular builds. If you wish to help contribute regular builds of the analyzer on other platforms, please get in touch via `LLVM Discourse <https://discourse.llvm.org/>`_. - -[Legacy] Using Packaged Builds ------------------------------- - -To use the legacy package builds, simply unpack it anywhere. If the build archive has the name **``checker-XXX.tar.bz2``** then the archive will expand to a directory called **``checker-XXX``**. You do not need to place this directory or the contents of this directory in any special place. Uninstalling the analyzer is as simple as deleting this directory. - -Most of the files in the **``checker-XXX``** directory will be supporting files for the analyzer that you can simply ignore. Most users will only care about two files, which are located at the top of the **``checker-XXX``** directory: - -* **scan-build**: ``scan-build`` is the high-level command line utility for running the analyzer -* **scan-view**: ``scan-view`` a companion command line utility to ``scan-build``, ``scan-view`` is used to view analysis results generated by ``scan-build``. There is an option that one can pass to ``scan-build`` to cause ``scan-view`` to run as soon as it the analysis of a build completes - +The Static Analyzer can be obtained as a part of Clang; for downloading and installing Clang visit the `LLVM releases page <https://releases.llvm.org/>`_. Once the analyzer is installed, follow the :doc:`CommandLineUsage` on using the command line to get started analyzing your code. _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
