mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-02 00:46:07 +00:00
093aaca2b0
User documentation currently found at https://clang-analyzer.llvm.org is migrated to RST format. This commit migrates all the relevant content, including suspicious or even clearly outdated parts. These issues will be cleaned up in separate follow-up commits (where the diff is not obscured by the format change). However, a few typos are fixed, and some parts (availability of binary releases, integration with XCode) are marked (with [Legacy] tags) to highlight that they are outdated. The primary motivation for this change is to update the facts in the docs and make them discoverable from the RST-generated doc-tree as well (many subpages are not accessible at all, as the menu generation for the HTML-based page is not working at all). This commit migrates all the relevant content, including parts that are suspicious or even clearly outdated. These issues will be cleaned up in separate follow-up commits (where the diff is not obscured by the format change). However, a few typos are fixed and some parts (availability of binary releases, integration with XCode) are marked (with [Legacy] tags) to highlight that they are outdated. The primary motivation for this change is to update the facts in the docs and make them discoverable from the RST-generated doc-tree as well (many subpages are not accessible **at all**, as the menu generation for the HTML based page is not working at all).
38 lines
2.4 KiB
ReStructuredText
38 lines
2.4 KiB
ReStructuredText
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 pacakge 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
|
|
|