This is an archive of the discontinued LLVM Phabricator instance.

Differential D64494

[analyzer]Add user docs rst
ClosedPublic

Authored by martong on Jul 10 2019, 7:26 AM.

Details

Reviewers
dkrupp
Commits
rGa23c5694fbb5: [analyzer]Add user docs rst
rL365639: [analyzer]Add user docs rst
rC365639: [analyzer]Add user docs rst
Summary

Add user documentation page. This is an empty page atm, later patches will add
the specific user documentatoins.

Diff Detail

Event Timeline

martong created this revision.Jul 10 2019, 7:26 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 10 2019, 7:26 AM
Herald added subscribers: cfe-commits, Charusso, gamesh411 and 9 others. · View Herald Transcript
Harbormaster completed remote builds in B34695: Diff 208958.Jul 10 2019, 7:27 AM
dkrupp accepted this revision.Jul 10 2019, 7:29 AM

I guess this is a placeholder for the subpages of "User Manual" @ https://clang-analyzer.llvm.org, which will be ported in follow-up patches.

This revision is now accepted and ready to land.Jul 10 2019, 7:29 AM
martong added a comment.Jul 10 2019, 7:46 AM
In D64494#1578373, @dkrupp wrote:

I guess this is a placeholder for the subpages of "User Manual" @ https://clang-analyzer.llvm.org, which will be ported in follow-up patches.

Yes.

Closed by commit rL365639: [analyzer]Add user docs rst (authored by martong). · Explain WhyJul 10 2019, 7:49 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptJul 10 2019, 7:49 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Szelethus added a comment.Jul 10 2019, 11:07 AM

I guess any time we modify analyzer stuff, we may invite the main analyzer developers to the patch review as well.

In any case, LGTM, if this really is a beginning of porting the already existing documentation to sphinx.

martong added a comment.Jul 10 2019, 12:22 PM

In any case, LGTM, if this really is a beginning of porting the already existing documentation to sphinx.

This is really the beginning of porting the existing docs to sphinx which is supposedly going to be done by @dkrupp. And I am planning to add new user manual documentation about CTU.

I guess any time we modify analyzer stuff, we may invite the main analyzer developers to the patch review as well.

Yes, I agree. I was under the impression that there is already a consensus between the analyzer devs about the sphinx movement. If there is not, please indicate and I'll revert.

Szelethus added a comment.Jul 10 2019, 12:42 PM

Np, please leave it in! :)

Revision Contents

PathSize
clang/
docs/
7 lines
analyzer/
4 lines

Diff 208958

clang/docs/ClangStaticAnalyzer.rst

===================== =====================
Clang Static Analyzer Clang Static Analyzer
===================== =====================
The Clang Static Analyzer is a source code analysis tool that finds bugs in C, C++, and Objective-C programs. 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. It implements *path-sensitive*, *inter-procedural analysis* based on *symbolic execution* technique.
This is the Static Analyzer documentation page. This is the Static Analyzer documentation page.
See the `Official Tool Page <https://clang-analyzer.llvm.org/>`_. See the `Official Tool Page <https://clang-analyzer.llvm.org/>`_.
.. toctree:: .. toctree::
:caption: Table of Contents :caption: Table of Contents
:numbered: :numbered:
:maxdepth: 2 :maxdepth: 2
analyzer/checkers analyzer/checkers
analyzer/user-docs
analyzer/developer-docs analyzer/developer-docs

clang/docs/analyzer/user-docs.rst

  • This file was added.
User Docs
=========
Contents: