Sean Silva | 99b51c4 | 2012-12-12 23:02:30 +0000 | [diff] [blame] | 1 | .. 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 Silva | aaa78ee | 2013-01-02 21:50:48 +0000 | [diff] [blame] | 6 | .. title:: Welcome to Clang's documentation! |
Sean Silva | 99b51c4 | 2012-12-12 23:02:30 +0000 | [diff] [blame] | 7 | |
Sean Silva | 99b51c4 | 2012-12-12 23:02:30 +0000 | [diff] [blame] | 8 | .. toctree:: |
Sean Silva | d2a98e6 | 2013-01-02 12:39:50 +0000 | [diff] [blame] | 9 | :maxdepth: 1 |
Sean Silva | 99b51c4 | 2012-12-12 23:02:30 +0000 | [diff] [blame] | 10 | |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 11 | ReleaseNotes |
12 | |||||
13 | Using Clang as a Compiler | ||||
Sean Silva | aaa78ee | 2013-01-02 21:50:48 +0000 | [diff] [blame] | 14 | ========================= |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 15 | |
16 | .. toctree:: | ||||
17 | :maxdepth: 1 | ||||
18 | |||||
19 | UsersManual | ||||
Richard Smith | 58e1474 | 2016-10-27 20:55:56 +0000 | [diff] [blame] | 20 | Toolchain |
Sean Silva | f380e0e | 2013-01-02 21:03:11 +0000 | [diff] [blame] | 21 | LanguageExtensions |
Richard Smith | 081ad4d | 2017-01-24 19:39:46 +0000 | [diff] [blame] | 22 | ClangCommandLineReference |
Aaron Ballman | 5142a2c | 2014-02-19 23:09:37 +0000 | [diff] [blame] | 23 | AttributeReference |
Richard Smith | b6a3b4b | 2016-09-12 05:58:29 +0000 | [diff] [blame] | 24 | DiagnosticsReference |
Renato Golin | f70e35d | 2013-09-08 20:44:39 +0000 | [diff] [blame] | 25 | CrossCompilation |
DeLesley Hutchins | c51e08c | 2014-02-18 19:42:01 +0000 | [diff] [blame] | 26 | ThreadSafetyAnalysis |
Sean Silva | bf9b4cd | 2012-12-13 01:10:46 +0000 | [diff] [blame] | 27 | AddressSanitizer |
Dmitri Gribenko | dd20f2c | 2012-12-23 18:35:58 +0000 | [diff] [blame] | 28 | ThreadSanitizer |
29 | MemorySanitizer | ||||
Alexey Samsonov | 778fc72 | 2015-12-04 17:30:29 +0000 | [diff] [blame] | 30 | UndefinedBehaviorSanitizer |
Peter Collingbourne | 276be3c | 2013-08-14 18:54:18 +0000 | [diff] [blame] | 31 | DataFlowSanitizer |
Sergey Matveev | 072db59 | 2013-12-10 20:10:30 +0000 | [diff] [blame] | 32 | LeakSanitizer |
Sergey Matveev | 07e2d28 | 2015-04-23 20:40:04 +0000 | [diff] [blame] | 33 | SanitizerCoverage |
Peter Collingbourne | dc13453 | 2016-01-16 00:31:22 +0000 | [diff] [blame] | 34 | SanitizerStats |
Alexey Samsonov | 2de6833 | 2013-08-07 08:23:32 +0000 | [diff] [blame] | 35 | SanitizerSpecialCaseList |
Peter Collingbourne | a4ccff3 | 2015-02-20 20:30:56 +0000 | [diff] [blame] | 36 | ControlFlowIntegrity |
Peter Collingbourne | 3afb266 | 2016-04-28 17:09:37 +0000 | [diff] [blame] | 37 | LTOVisibility |
Peter Collingbourne | c4122c1 | 2015-06-15 21:08:13 +0000 | [diff] [blame] | 38 | SafeStack |
Vlad Tsyrklevich | e55aa03 | 2018-04-03 22:33:53 +0000 | [diff] [blame] | 39 | ShadowCallStack |
Vedant Kumar | a530a36 | 2016-06-02 00:51:50 +0000 | [diff] [blame] | 40 | SourceBasedCodeCoverage |
Douglas Gregor | de0beaa | 2013-03-22 06:21:35 +0000 | [diff] [blame] | 41 | Modules |
Reid Kleckner | 4913394 | 2014-02-28 23:46:04 +0000 | [diff] [blame] | 42 | MSVCCompatibility |
Alexey Bataev | 8ede819 | 2018-01-08 19:02:51 +0000 | [diff] [blame] | 43 | OpenMPSupport |
Teresa Johnson | 8de6346 | 2016-09-21 16:57:03 +0000 | [diff] [blame] | 44 | ThinLTO |
Andrew Wilkins | 6238c6f | 2015-06-30 02:52:38 +0000 | [diff] [blame] | 45 | CommandGuide/index |
Dmitri Gribenko | 4077efc | 2013-01-06 13:38:34 +0000 | [diff] [blame] | 46 | FAQ |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 47 | |
48 | Using Clang as a Library | ||||
Sean Silva | aaa78ee | 2013-01-02 21:50:48 +0000 | [diff] [blame] | 49 | ======================== |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 50 | |
51 | .. toctree:: | ||||
52 | :maxdepth: 1 | ||||
53 | |||||
54 | Tooling | ||||
Sean Silva | f2a472a | 2013-02-19 17:29:01 +0000 | [diff] [blame] | 55 | ExternalClangExamples |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 56 | IntroductionToTheClangAST |
57 | LibTooling | ||||
Daniel Jasper | 85a77c1 | 2013-01-09 21:49:28 +0000 | [diff] [blame] | 58 | LibFormat |
Sean Silva | bf9b4cd | 2012-12-13 01:10:46 +0000 | [diff] [blame] | 59 | ClangPlugins |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 60 | RAVFrontendAction |
61 | LibASTMatchersTutorial | ||||
62 | LibASTMatchers | ||||
Sean Silva | bf9b4cd | 2012-12-13 01:10:46 +0000 | [diff] [blame] | 63 | HowToSetupToolingForLLVM |
Sean Silva | bf9b4cd | 2012-12-13 01:10:46 +0000 | [diff] [blame] | 64 | JSONCompilationDatabase |
Alex Lorenz | 80275fe | 2017-09-29 12:21:38 +0000 | [diff] [blame] | 65 | RefactoringEngine |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 66 | |
Daniel Jasper | 85a77c1 | 2013-01-09 21:49:28 +0000 | [diff] [blame] | 67 | Using Clang Tools |
68 | ================= | ||||
69 | |||||
70 | .. toctree:: | ||||
71 | :maxdepth: 1 | ||||
72 | |||||
73 | ClangTools | ||||
74 | ClangCheck | ||||
75 | ClangFormat | ||||
Alexander Kornienko | d278e0e | 2013-09-04 15:09:13 +0000 | [diff] [blame] | 76 | ClangFormatStyleOptions |
Daniel Jasper | 85a77c1 | 2013-01-09 21:49:28 +0000 | [diff] [blame] | 77 | |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 78 | Design Documents |
Sean Silva | aaa78ee | 2013-01-02 21:50:48 +0000 | [diff] [blame] | 79 | ================ |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 80 | |
81 | .. toctree:: | ||||
82 | :maxdepth: 1 | ||||
83 | |||||
Dmitri Gribenko | d9d2607 | 2012-12-15 20:41:17 +0000 | [diff] [blame] | 84 | InternalsManual |
Sean Silva | 5f25c50 | 2012-12-21 00:16:53 +0000 | [diff] [blame] | 85 | DriverInternals |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 86 | PTHInternals |
87 | PCHInternals | ||||
Dmitry Polukhin | 5af55b6 | 2016-03-09 19:39:16 +0000 | [diff] [blame] | 88 | ItaniumMangleAbiTags |
Kostya Serebryany | f51f580 | 2017-12-04 20:01:38 +0000 | [diff] [blame] | 89 | HardwareAssistedAddressSanitizerDesign.rst |
Sean Silva | dd9f406 | 2013-01-02 12:41:24 +0000 | [diff] [blame] | 90 | |
91 | |||||
Sean Silva | 99b51c4 | 2012-12-12 23:02:30 +0000 | [diff] [blame] | 92 | Indices and tables |
93 | ================== | ||||
94 | |||||
95 | * :ref:`genindex` | ||||
96 | * :ref:`modindex` | ||||
97 | * :ref:`search` | ||||
98 |