2012-12-13 07:02:30 +08:00
|
|
|
.. Clang documentation master file, created by
|
|
|
|
sphinx-quickstart on Sun Dec 9 20:01:55 2012.
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
2013-01-03 05:50:48 +08:00
|
|
|
.. title:: Welcome to Clang's documentation!
|
2012-12-13 07:02:30 +08:00
|
|
|
|
|
|
|
.. toctree::
|
2013-01-02 20:39:50 +08:00
|
|
|
:maxdepth: 1
|
2012-12-13 07:02:30 +08:00
|
|
|
|
2013-01-02 20:41:24 +08:00
|
|
|
ReleaseNotes
|
|
|
|
|
|
|
|
Using Clang as a Compiler
|
2013-01-03 05:50:48 +08:00
|
|
|
=========================
|
2013-01-02 20:41:24 +08:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
UsersManual
|
2013-01-03 05:03:11 +08:00
|
|
|
LanguageExtensions
|
2014-02-20 07:09:37 +08:00
|
|
|
AttributeReference
|
2013-09-09 04:44:39 +08:00
|
|
|
CrossCompilation
|
2014-02-19 03:42:01 +08:00
|
|
|
ThreadSafetyAnalysis
|
2012-12-13 09:10:46 +08:00
|
|
|
AddressSanitizer
|
2012-12-24 02:35:58 +08:00
|
|
|
ThreadSanitizer
|
|
|
|
MemorySanitizer
|
2015-12-05 01:30:29 +08:00
|
|
|
UndefinedBehaviorSanitizer
|
2013-08-15 02:54:18 +08:00
|
|
|
DataFlowSanitizer
|
2013-12-11 04:10:30 +08:00
|
|
|
LeakSanitizer
|
2015-04-24 04:40:04 +08:00
|
|
|
SanitizerCoverage
|
2016-01-16 08:31:22 +08:00
|
|
|
SanitizerStats
|
2013-08-07 16:23:32 +08:00
|
|
|
SanitizerSpecialCaseList
|
2015-02-21 04:30:56 +08:00
|
|
|
ControlFlowIntegrity
|
2016-04-29 01:09:37 +08:00
|
|
|
LTOVisibility
|
2015-06-16 05:08:13 +08:00
|
|
|
SafeStack
|
2013-03-22 14:21:35 +08:00
|
|
|
Modules
|
2014-03-01 07:46:04 +08:00
|
|
|
MSVCCompatibility
|
Sphinx-based clang man pages
Summary:
This diff introduces .rst files, Sphinx config, and a CMake target
for building clang man pages. This will deprecate the existing .pod-
based man page, and will integrate nicely with CMake. This diff does
not remove the existing man page; that will be done in a follow-up
once packagers have had a chance to react to the change.
For now, only clang(1) has been done; others can be added over time
by dropping additional files into the docs/CommandGuide directory.
The index page for CommandGuide has been copied from LLVM's
docs/CommandGuide.
The man page itself is mostly the same, with a few minor cosmetic
changes. The only major change is the SYNOPSIS section. I was unable
to get .rst/Sphinx produce the same style as in the existing man page.
Instead, I changed it to match the LLVM tools' relatively simple style.
To build the man pages, use the "docs-clang-man" target if building
with CMake. Otherwise, use "make -f Makefile.sphinx man".
Reviewers: cmatthews, silvas
Subscribers: dim, gaeke, beanz, cfe-commits
Differential Revision: http://reviews.llvm.org/D10562
llvm-svn: 241037
2015-06-30 10:52:38 +08:00
|
|
|
CommandGuide/index
|
2013-01-06 21:38:34 +08:00
|
|
|
FAQ
|
2013-01-02 20:41:24 +08:00
|
|
|
|
|
|
|
Using Clang as a Library
|
2013-01-03 05:50:48 +08:00
|
|
|
========================
|
2013-01-02 20:41:24 +08:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
Tooling
|
2013-02-20 01:29:01 +08:00
|
|
|
ExternalClangExamples
|
2013-01-02 20:41:24 +08:00
|
|
|
IntroductionToTheClangAST
|
|
|
|
LibTooling
|
2013-01-10 05:49:28 +08:00
|
|
|
LibFormat
|
2012-12-13 09:10:46 +08:00
|
|
|
ClangPlugins
|
2013-01-02 20:41:24 +08:00
|
|
|
RAVFrontendAction
|
|
|
|
LibASTMatchersTutorial
|
|
|
|
LibASTMatchers
|
2012-12-13 09:10:46 +08:00
|
|
|
HowToSetupToolingForLLVM
|
|
|
|
JSONCompilationDatabase
|
2013-01-02 20:41:24 +08:00
|
|
|
|
2013-01-10 05:49:28 +08:00
|
|
|
Using Clang Tools
|
|
|
|
=================
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
ClangTools
|
|
|
|
ClangCheck
|
|
|
|
ClangFormat
|
2013-09-04 23:09:13 +08:00
|
|
|
ClangFormatStyleOptions
|
2013-01-10 05:49:28 +08:00
|
|
|
|
2013-01-02 20:41:24 +08:00
|
|
|
Design Documents
|
2013-01-03 05:50:48 +08:00
|
|
|
================
|
2013-01-02 20:41:24 +08:00
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
|
2012-12-16 04:41:17 +08:00
|
|
|
InternalsManual
|
2012-12-21 08:16:53 +08:00
|
|
|
DriverInternals
|
2013-01-02 20:41:24 +08:00
|
|
|
PTHInternals
|
|
|
|
PCHInternals
|
2016-03-10 03:39:16 +08:00
|
|
|
ItaniumMangleAbiTags
|
2013-01-02 20:41:24 +08:00
|
|
|
|
|
|
|
|
2012-12-13 07:02:30 +08:00
|
|
|
Indices and tables
|
|
|
|
==================
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
* :ref:`modindex`
|
|
|
|
* :ref:`search`
|
|
|
|
|