blob: be7a371cd71113e2438d0a99ae1bda9189780c3a [file] [log] [blame]
Sean Silva99b51c42012-12-12 23:02:30 +00001.. Clang documentation master file, created by
2 sphinx-quickstart on Sun Dec 9 20:01:55 2012.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
Sean Silvaaaa78ee2013-01-02 21:50:48 +00006.. title:: Welcome to Clang's documentation!
Sean Silva99b51c42012-12-12 23:02:30 +00007
Sean Silva99b51c42012-12-12 23:02:30 +00008.. toctree::
Sean Silvad2a98e62013-01-02 12:39:50 +00009 :maxdepth: 1
Sean Silva99b51c42012-12-12 23:02:30 +000010
Sean Silvadd9f4062013-01-02 12:41:24 +000011 ReleaseNotes
12
13Using Clang as a Compiler
Sean Silvaaaa78ee2013-01-02 21:50:48 +000014=========================
Sean Silvadd9f4062013-01-02 12:41:24 +000015
16.. toctree::
17 :maxdepth: 1
18
19 UsersManual
Richard Smith58e14742016-10-27 20:55:56 +000020 Toolchain
Sean Silvaf380e0e2013-01-02 21:03:11 +000021 LanguageExtensions
Richard Smith081ad4d2017-01-24 19:39:46 +000022 ClangCommandLineReference
Aaron Ballman5142a2c2014-02-19 23:09:37 +000023 AttributeReference
Richard Smithb6a3b4b2016-09-12 05:58:29 +000024 DiagnosticsReference
Renato Golinf70e35d2013-09-08 20:44:39 +000025 CrossCompilation
DeLesley Hutchinsc51e08c2014-02-18 19:42:01 +000026 ThreadSafetyAnalysis
Sean Silvabf9b4cd2012-12-13 01:10:46 +000027 AddressSanitizer
Dmitri Gribenkodd20f2c2012-12-23 18:35:58 +000028 ThreadSanitizer
29 MemorySanitizer
Alexey Samsonov778fc722015-12-04 17:30:29 +000030 UndefinedBehaviorSanitizer
Peter Collingbourne276be3c2013-08-14 18:54:18 +000031 DataFlowSanitizer
Sergey Matveev072db592013-12-10 20:10:30 +000032 LeakSanitizer
Sergey Matveev07e2d282015-04-23 20:40:04 +000033 SanitizerCoverage
Peter Collingbournedc134532016-01-16 00:31:22 +000034 SanitizerStats
Alexey Samsonov2de68332013-08-07 08:23:32 +000035 SanitizerSpecialCaseList
Peter Collingbournea4ccff32015-02-20 20:30:56 +000036 ControlFlowIntegrity
Peter Collingbourne3afb2662016-04-28 17:09:37 +000037 LTOVisibility
Peter Collingbournec4122c12015-06-15 21:08:13 +000038 SafeStack
Vlad Tsyrkleviche55aa032018-04-03 22:33:53 +000039 ShadowCallStack
Vedant Kumara530a362016-06-02 00:51:50 +000040 SourceBasedCodeCoverage
Douglas Gregorde0beaa2013-03-22 06:21:35 +000041 Modules
Reid Kleckner49133942014-02-28 23:46:04 +000042 MSVCCompatibility
Alexey Bataev8ede8192018-01-08 19:02:51 +000043 OpenMPSupport
Teresa Johnson8de63462016-09-21 16:57:03 +000044 ThinLTO
Andrew Wilkins6238c6f2015-06-30 02:52:38 +000045 CommandGuide/index
Dmitri Gribenko4077efc2013-01-06 13:38:34 +000046 FAQ
Sean Silvadd9f4062013-01-02 12:41:24 +000047
48Using Clang as a Library
Sean Silvaaaa78ee2013-01-02 21:50:48 +000049========================
Sean Silvadd9f4062013-01-02 12:41:24 +000050
51.. toctree::
52 :maxdepth: 1
53
54 Tooling
Sean Silvaf2a472a2013-02-19 17:29:01 +000055 ExternalClangExamples
Sean Silvadd9f4062013-01-02 12:41:24 +000056 IntroductionToTheClangAST
57 LibTooling
Daniel Jasper85a77c12013-01-09 21:49:28 +000058 LibFormat
Sean Silvabf9b4cd2012-12-13 01:10:46 +000059 ClangPlugins
Sean Silvadd9f4062013-01-02 12:41:24 +000060 RAVFrontendAction
61 LibASTMatchersTutorial
62 LibASTMatchers
Sean Silvabf9b4cd2012-12-13 01:10:46 +000063 HowToSetupToolingForLLVM
Sean Silvabf9b4cd2012-12-13 01:10:46 +000064 JSONCompilationDatabase
Alex Lorenz80275fe2017-09-29 12:21:38 +000065 RefactoringEngine
Sean Silvadd9f4062013-01-02 12:41:24 +000066
Daniel Jasper85a77c12013-01-09 21:49:28 +000067Using Clang Tools
68=================
69
70.. toctree::
71 :maxdepth: 1
72
73 ClangTools
74 ClangCheck
75 ClangFormat
Alexander Kornienkod278e0e2013-09-04 15:09:13 +000076 ClangFormatStyleOptions
Daniel Jasper85a77c12013-01-09 21:49:28 +000077
Sean Silvadd9f4062013-01-02 12:41:24 +000078Design Documents
Sean Silvaaaa78ee2013-01-02 21:50:48 +000079================
Sean Silvadd9f4062013-01-02 12:41:24 +000080
81.. toctree::
82 :maxdepth: 1
83
Dmitri Gribenkod9d26072012-12-15 20:41:17 +000084 InternalsManual
Sean Silva5f25c502012-12-21 00:16:53 +000085 DriverInternals
Sean Silvadd9f4062013-01-02 12:41:24 +000086 PTHInternals
87 PCHInternals
Dmitry Polukhin5af55b62016-03-09 19:39:16 +000088 ItaniumMangleAbiTags
Kostya Serebryanyf51f5802017-12-04 20:01:38 +000089 HardwareAssistedAddressSanitizerDesign.rst
Sean Silvadd9f4062013-01-02 12:41:24 +000090
91
Sean Silva99b51c42012-12-12 23:02:30 +000092Indices and tables
93==================
94
95* :ref:`genindex`
96* :ref:`modindex`
97* :ref:`search`
98