maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/clang/docs/index.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

102 lines
1.7 KiB
ReStructuredText
Raw Normal View History

docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. llvm-svn: 170042
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.
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. llvm-svn: 171417
2013-01-03 05:50:48 +08:00
.. title:: Welcome to Clang's documentation!
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. llvm-svn: 170042
2012-12-13 07:02:30 +08:00
.. toctree::
docs: Decrease toctree depth on landing page. Having the table of contents there was making it hard to easily see at a glance all the docs we have. llvm-svn: 171376
2013-01-02 20:39:50 +08:00
:maxdepth: 1
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. llvm-svn: 170042
2012-12-13 07:02:30 +08:00
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
ReleaseNotes
Using Clang as a Compiler
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. llvm-svn: 171417
2013-01-03 05:50:48 +08:00
=========================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
.. toctree::
:maxdepth: 1
UsersManual
Add documentation describing the components of a complete toolchain including Clang. llvm-svn: 285341
2016-10-28 04:55:56 +08:00
Toolchain
docs: Reorganize landing page. Language extensions are highly relevant to using clang as a compiler, so move LanguageExtensions up into `Using Clang as a Compiler` on the landing page. The other documents from the now-gone `Language Extensions and Specs` section on the landing page nicely fit hierarchically under LanguageExtensions.rst, so put them under LanguageExtensions.rst's toctree instead of on the landing page. Impetus from Jordan Rose. llvm-svn: 171409
2013-01-03 05:03:11 +08:00
LanguageExtensions
[docs] Add TableGen-based generator for command line argument documentation, and generate documentation for all (non-hidden) options supported by the 'clang' driver. llvm-svn: 292968
2017-01-25 03:39:46 +08:00
ClangCommandLineReference
Until attribute documentation is implemented as a server-side feature, I will be manually committing AttributeReference.rst so that attribute documentation can be on the live server instead of simply disappearing from the language extensions page without obvious replacement. This is a temporary stop-gap solution until server-side generation is implemented, at which point the AttributeReference.rst will go back to holding placeholder text. llvm-svn: 201733
2014-02-20 07:09:37 +08:00
AttributeReference
Add a mode to clang-tblgen to generate reference documentation for warning and remark flags. For now I'm checking in a copy of the built documentation, but we can replace this with a placeholder (as we do for the attributes reference documentation) once we enable building this server-side. llvm-svn: 281192
2016-09-12 13:58:29 +08:00
DiagnosticsReference
Adding cross-compilation instructions to Clang llvm-svn: 190281
2013-09-09 04:44:39 +08:00
CrossCompilation
[analyzer] Creating standard Sphinx documentation The lack of documentation has been a long standing issue in the Static Analyzer, and one of the leading reasons behind this was a lack of good documentation infrastucture. This lead serious drawbacks, such as * Not having proper release notes for years * Not being able to have a sensible auto-generated checker documentations (which lead to most of them not having any) * The HTML website that has to updated manually is a chore, and has been outdated for a long while * Many design discussions are now hidden in phabricator revisions This patch implements a new documentation infrastucture using Sphinx, like most of the other subprojects in LLVM. It transformed some pages as a proof-of- concept, with many others to follow in later patches. The eventual goal is to preserve the original website's (https://clang-analyzer.llvm.org/) frontpage, but move everything else to the new format. Some other ideas, like creating a unipage for each checker (similar to how clang-tidy works now), are also being discussed. Patch by Dániel Krupp! Differential Revision: https://reviews.llvm.org/D54429 llvm-svn: 353126
2019-02-05 08:39:33 +08:00
ClangStaticAnalyzer
Updated documentation for Thread Safety Analysis. llvm-svn: 201598
2014-02-19 03:42:01 +08:00
ThreadSafetyAnalysis
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. llvm-svn: 170067
2012-12-13 09:10:46 +08:00
AddressSanitizer
Documentation: add MemorySanitizer to the toctree llvm-svn: 171003
2012-12-24 02:35:58 +08:00
ThreadSanitizer
MemorySanitizer
Clang documentation for UBSan. Summary: Create a separate page describing UBSan tool, move the description of fine-grained checks there, provide extra information about supported platforms, symbolization etc. This text is compiled from four parts: * Existing documentation copied from User's Manual * Layout used in documentation for another sanitizers (ASan, MSan etc.) * Text written from scratch * Small parts taken from Michael Morrison's attempt at creating UBSan page: http://lists.llvm.org/pipermail/llvm-commits/Week-of-Mon-20141215/249503.html Reviewers: kcc, rsmith, silvas Subscribers: tberghammer, danalbert, srhines, kcc Differential Revision: http://reviews.llvm.org/D15217 llvm-svn: 254733
2015-12-05 01:30:29 +08:00
UndefinedBehaviorSanitizer
Add support for -fsanitize-blacklist and default blacklists for DFSan. Also add some documentation. Differential Revision: http://llvm-reviews.chandlerc.com/D1346 llvm-svn: 188403
2013-08-15 02:54:18 +08:00
DataFlowSanitizer
Rewrite docs/LeakSanitizer.rst. Add it to index. llvm-svn: 196957
2013-12-11 04:10:30 +08:00
LeakSanitizer
Add clang/docs/SanitizerCoverage.rst Moved from https://code.google.com/p/address-sanitizer/wiki/AsanCoverage llvm-svn: 235643
2015-04-24 04:40:04 +08:00
SanitizerCoverage
Introduce -fsanitize-stats flag. This is part of a new statistics gathering feature for the sanitizers. See clang/docs/SanitizerStats.rst for further info and docs. Differential Revision: http://reviews.llvm.org/D16175 llvm-svn: 257971
2016-01-16 08:31:22 +08:00
SanitizerStats
Documentation for sanitizer special case list format and -f(no-)?sanitize-blacklist flag llvm-svn: 187871
2013-08-07 16:23:32 +08:00
SanitizerSpecialCaseList
Implement Control Flow Integrity for virtual calls. This patch introduces the -fsanitize=cfi-vptr flag, which enables a control flow integrity scheme that checks that virtual calls take place using a vptr of the correct dynamic type. More details in the new docs/ControlFlowIntegrity.rst file. It also introduces the -fsanitize=cfi flag, which is currently a synonym for -fsanitize=cfi-vptr, but will eventually cover all CFI checks implemented in Clang. Differential Revision: http://reviews.llvm.org/D7424 llvm-svn: 230055
2015-02-21 04:30:56 +08:00
ControlFlowIntegrity
Re-apply r267784, r267824 and r267830. I have updated the compiler-rt tests. llvm-svn: 267903
2016-04-29 01:09:37 +08:00
LTOVisibility
Protection against stack-based memory corruption errors using SafeStack: Clang command line option and function attribute This patch adds the -fsanitize=safe-stack command line argument for clang, which enables the Safe Stack protection (see http://reviews.llvm.org/D6094 for the detailed description of the Safe Stack). This patch is our implementation of the safe stack on top of Clang. The patches make the following changes: - Add -fsanitize=safe-stack and -fno-sanitize=safe-stack options to clang to control safe stack usage (the safe stack is disabled by default). - Add __attribute__((no_sanitize("safe-stack"))) attribute to clang that can be used to disable the safe stack for individual functions even when enabled globally. Original patch by Volodymyr Kuznetsov and others at the Dependable Systems Lab at EPFL; updates and upstreaming by myself. Differential Revision: http://reviews.llvm.org/D6095 llvm-svn: 239762
2015-06-16 05:08:13 +08:00
SafeStack
Add the -fsanitize=shadow-call-stack flag Summary: Add support for the -fsanitize=shadow-call-stack flag which causes clang to add ShadowCallStack attribute to functions compiled with that flag enabled. Reviewers: pcc, kcc Reviewed By: pcc, kcc Subscribers: cryptoad, cfe-commits, kcc Differential Revision: https://reviews.llvm.org/D44801 llvm-svn: 329122
2018-04-04 06:33:53 +08:00
ShadowCallStack
[docs] Document the source-based code coverage feature Differential Revision: http://reviews.llvm.org/D20715 llvm-svn: 271454
2016-06-02 08:51:50 +08:00
SourceBasedCodeCoverage
More documentation on the module map language. llvm-svn: 177704
2013-03-22 14:21:35 +08:00
Modules
Add Clang docs about MSVC compatibility This documents some of the status of supported functionality in MSVC quirks mode. Some of this should be in http://clang.llvm.org/compatibility.html instead when things have stabilized. llvm-svn: 202559
2014-03-01 07:46:04 +08:00
MSVCCompatibility
[OpenCL] Add doc to describe OpenCL support The idea of this page is to document work in progress functionality and also describe the plan of future development work. Patch by Anastasia Stulova. Differential Revision: https://reviews.llvm.org/D69072 llvm-svn: 375111
2019-10-17 20:56:02 +08:00
OpenCLSupport
[OPENMP] Current status of OpenMP support. Summary: Some info about supported features of OpenMP 4.5-5.0. Reviewers: hfinkel, rsmith Subscribers: kkwli0, Hahnfeld, cfe-commits Differential Revision: https://reviews.llvm.org/D39457 llvm-svn: 322018
2018-01-09 03:02:51 +08:00
OpenMPSupport
[docs] Add ThinLTO user documentation Summary: Add some user facing documentation on ThinLTO and how to use it. Reviewers: mehdi_amini Subscribers: mehdi_amini, cfe-commits Differential Revision: https://reviews.llvm.org/D24806 llvm-svn: 282089
2016-09-22 00:57:03 +08:00
ThinLTO
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
Clang docs: add some information about the difference between 'clang' and 'clang -cc1' This is coming up again and again on the mailing list and IRC. llvm-svn: 171656
2013-01-06 21:38:34 +08:00
FAQ
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
Using Clang as a Library
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. llvm-svn: 171417
2013-01-03 05:50:48 +08:00
========================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
.. toctree::
:maxdepth: 1
Tooling
[docs] Rename to permit wider variety of content. I don't want to rule out the possibility of linking to e.g. interesting blog posts about uses of Clang, so avoid restricting the content to "projects". This breaks URL compatibility, but this document was committed less than an hour ago so hopefully nobody has linked to it yet. llvm-svn: 175535
2013-02-20 01:29:01 +08:00
ExternalClangExamples
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
IntroductionToTheClangAST
LibTooling
Add documentation for clang-format. This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. llvm-svn: 172004
2013-01-10 05:49:28 +08:00
LibFormat
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. llvm-svn: 170067
2012-12-13 09:10:46 +08:00
ClangPlugins
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
RAVFrontendAction
LibASTMatchersTutorial
LibASTMatchers
Add User docs for ASTImporter Summary: This document includes the description of the ASTImporter from the user/client perspective. A subsequent patch will describe the development internals. Reviewers: a_sidorin, shafik, gamesh411, balazske, a.sidorin Subscribers: rnkovacs, dkrupp, arphaman, Szelethus, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D65573 llvm-svn: 368009
2019-08-06 17:52:21 +08:00
LibASTImporter
docs: More reST conversion. Sorry for the large commit, but it is much faster to convert in batches. llvm-svn: 170067
2012-12-13 09:10:46 +08:00
HowToSetupToolingForLLVM
JSONCompilationDatabase
[docs][refactor] Add refactoring engine design documentation This commit adds a refactoring engine design document that talks about the design and provides several example of how the engine can be used. Differential Revision: https://reviews.llvm.org/D37976 llvm-svn: 314509
2017-09-29 20:21:38 +08:00
RefactoringEngine
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
Add documentation for clang-format. This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. llvm-svn: 172004
2013-01-10 05:49:28 +08:00
Using Clang Tools
=================
.. toctree::
:maxdepth: 1
ClangTools
ClangCheck
ClangFormat
Added documentation for clang-format style options. Summary: The main contents is in the ClangFormatStyleOptions.rst, which can be updated from the Format.h by the dump_format_style.py script. Reviewers: djasper, klimek Reviewed By: klimek CC: cfe-commits Differential Revision: http://llvm-reviews.chandlerc.com/D1597 llvm-svn: 189946
2013-09-04 23:09:13 +08:00
ClangFormatStyleOptions
Add documentation for clang-format. This adds documentation for both LibFormat as well as the standalone tools and integrations built on top of it. It slightly restructures the ClangTools documentation. llvm-svn: 172004
2013-01-10 05:49:28 +08:00
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
Design Documents
docs: Take advantage of extra level of headings. The way Sphinx treats the "top-level" adornments is weird. It usually uses the first top-level adornment as the page title, even if the top-level adornment is just one "section" out of many (i.e. if the first section is "Introduction", then it will make the page title be "Introduction"). This behavior can be overriden by using an explicit `.. title::` directive to set the title. Since the Sphinx stylesheet that Clang is currently using ('haiku') nicely puts the document title at the top of the page in the header, this weird default behavior was resulting in a redundant "title" in the body content. Getting rid of this redundant level of headings effectively "exposes" one more level of heading from the stylesheet to which now makes the real "sections" more distinct. llvm-svn: 171417
2013-01-03 05:50:48 +08:00
================
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
.. toctree::
:maxdepth: 1
Documentation: convert InternalsManual.html to reST Patch by Anastasi Voitova with with small fixes by me. llvm-svn: 170275
2012-12-16 04:41:17 +08:00
InternalsManual
docs: Convert DriverInternals to reST. llvm-svn: 170812
2012-12-21 08:16:53 +08:00
DriverInternals
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
PCHInternals
NFC fix documentation build by rL263015 This time I hope it will fix the build for real. llvm-svn: 263052
2016-03-10 03:39:16 +08:00
ItaniumMangleAbiTags
design document for a hardware-assisted memory safety (HWAMS) tool, similar to AddressSanitizer Summary: preliminary design document for a hardware-assisted memory safety (HWAMS) tool, similar to AddressSanitizer The name TaggedAddressSanitizer and the rest of the document, are early draft, suggestions are welcome. The code will follow shortly. Reviewers: eugenis, alekseyshl Reviewed By: eugenis Subscribers: davidxl, cryptoad, fedor.sergeev, cfe-commits, llvm-commits Differential Revision: https://reviews.llvm.org/D40568 llvm-svn: 319684
2017-12-05 04:01:38 +08:00
HardwareAssistedAddressSanitizerDesign.rst
[Clang Interpreter] Initial patch for the constexpr interpreter Summary: This patch introduces the skeleton of the constexpr interpreter, capable of evaluating a simple constexpr functions consisting of if statements. The interpreter is described in more detail in the RFC. Further patches will add more features. Reviewers: Bigcheese, jfb, rsmith Subscribers: bruno, uenoku, ldionne, Tyker, thegameg, tschuett, dexonsmith, mgorny, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D64146 llvm-svn: 371834
2019-09-13 17:46:16 +08:00
ConstantInterpreter
docs: Reorganize landing page. I clustered the docs by some intuitive/fuzzy notion of "similarity", and some reasonable categories seemed to materialize. I tried to give the clusters useful names, but you may want to take a look at the landing page (<http://clang.llvm.org/docs/> for the lazy) and share your thoughts. I have to say, this small change really gives the docs a whole new life! It makes our documentation quite a bit easier to navigate and scope out. llvm-svn: 171379
2013-01-02 20:41:24 +08:00
docs: Initial Sphinx setup for Clang. I don't think this will be visible just yet on <clang.llvm.org/docs/> since I don't think that the necessary server-side setup has taken place. Don't shoot me over the theme. I don't want to duplicate LLVM's theme into the clang repo at the moment, so I just used one of Sphinx's default themes. llvm-svn: 170042
2012-12-13 07:02:30 +08:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`