[PATCH] D54429: [analyzer] Creating standard Sphinx documentation

Daniel Krupp via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue Nov 13 07:16:46 PST 2018


dkrupp updated this revision to Diff 173846.
dkrupp added a comment.

-scanbuild and xcode pictures are included now
-intro text ("What is Static Analysis?" etc.) are put under the Introduction section
-Download section is created, but I am not sure how well was the this Mac OSX binary release section was maintained. Should users really download from this site or through a package manager instead?

I will transform all the subpages after we come to an agreement that this is the way to go. For now, there are links to the old sub-pages from the main page.

@dcoughlin what do you think?

This is the current status.
Done:
Main: https://clang-analyzer.llvm.org/
Main/User manual/available checks: https://clang-analyzer.llvm.org/available_checks.html
Main/Mailing Lists

Not done:
Main/Filing Bugs: https://clang-analyzer.llvm.org/filing_bugs.html
Main/User manual/Obtaining the analyzer: https://clang-analyzer.llvm.org/installation.html
Main/User manual/Command line usage: https://clang-analyzer.llvm.org/scan-build.html
Main/User manual/Using within XCode: https://clang-analyzer.llvm.org/xcode.html
Main/Development/Checker Developer Manual: https://clang-analyzer.llvm.org/checker_dev_manual.html
Main/Development/Open Projects: https://clang-analyzer.llvm.org/open_projects.html
Main/Development/Potential Future Checkers: https://clang-analyzer.llvm.org/potential_checkers.html
Main/User manual/Source level annotations: https://clang-analyzer.llvm.org/annotations.html
Main/User manual/FAQ: https://clang-analyzer.llvm.org/faq.html


https://reviews.llvm.org/D54429

Files:
  docs/ClangStaticAnalyzer.rst
  docs/analyzer/DesignDiscussions/IPA.rst
  docs/analyzer/DesignDiscussions/InitializerLists.rst
  docs/analyzer/DesignDiscussions/RegionStore.rst
  docs/analyzer/DesignDiscussions/nullability.rst
  docs/analyzer/IPA.txt
  docs/analyzer/RegionStore.txt
  docs/analyzer/checkers.rst
  docs/analyzer/checkers/UninitializedObject.rst
  docs/analyzer/images/analyzer_xcode_html.png
  docs/analyzer/nullability.rst
  docs/conf.py
  docs/index.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D54429.173846.patch
Type: text/x-patch
Size: 98987 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20181113/6905b59e/attachment-0001.bin>


More information about the cfe-commits mailing list