diff options
author | Kristof Umann <dkszelethus@gmail.com> | 2019-02-05 00:39:33 +0000 |
---|---|---|
committer | Kristof Umann <dkszelethus@gmail.com> | 2019-02-05 00:39:33 +0000 |
commit | 0ee689c80313bed6e234367ea69d081d6a35bf25 (patch) | |
tree | e6069ac1b494bddfca81bedf20db8178c92de615 /docs/ClangStaticAnalyzer.rst | |
parent | 24c8a9a6ae8d231295b8deca1c1a47920e326fe5 (diff) | |
download | clang-0ee689c80313bed6e234367ea69d081d6a35bf25.tar.gz |
[analyzer] Creating standard Sphinx documentation
The lack of documentation has been a long standing issue in the Static Analyzer,
and one of the leading reasons behind this was a lack of good documentation
infrastucture.
This lead serious drawbacks, such as
* Not having proper release notes for years
* Not being able to have a sensible auto-generated checker documentations (which
lead to most of them not having any)
* The HTML website that has to updated manually is a chore, and has been
outdated for a long while
* Many design discussions are now hidden in phabricator revisions
This patch implements a new documentation infrastucture using Sphinx, like most
of the other subprojects in LLVM. It transformed some pages as a proof-of-
concept, with many others to follow in later patches. The eventual goal is to
preserve the original website's (https://clang-analyzer.llvm.org/) frontpage,
but move everything else to the new format.
Some other ideas, like creating a unipage for each checker (similar to how
clang-tidy works now), are also being discussed.
Patch by Dániel Krupp!
Differential Revision: https://reviews.llvm.org/D54429
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@353126 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/ClangStaticAnalyzer.rst')
-rw-r--r-- | docs/ClangStaticAnalyzer.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/ClangStaticAnalyzer.rst b/docs/ClangStaticAnalyzer.rst new file mode 100644 index 0000000000..f18fd81384 --- /dev/null +++ b/docs/ClangStaticAnalyzer.rst @@ -0,0 +1,19 @@ +===================== +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. + +See the `Official Tool Page <https://clang-analyzer.llvm.org/>`_. + +.. toctree:: + :caption: Table of Contents + :numbered: + :maxdepth: 2 + + analyzer/checkers + analyzer/developer-docs + |