llvm-project/llvm/docs
David Chisnall 83a561584d [Doc] Guideline on adding exception handling support for a target
Summary:
This is the first attempt to write down a guideline on adding exception handling support for a target. The content basically bases on the discussion on [1]. If you guys know who is exception handling expert, please add him as the reviewer. Thanks.

[1] http://lists.llvm.org/pipermail/llvm-dev/2018-January/120405.html

Reviewers: t.p.northover, theraven, nemanjai

Reviewed By: theraven

Subscribers: sdardis, llvm-commits

Differential Revision: https://reviews.llvm.org/D42178

llvm-svn: 323311
2018-01-24 09:53:01 +00:00
..
CommandGuide [MC] Fix -stack-size-section on ARM 2018-01-17 09:01:29 +00:00
Frontend
HistoricalNotes
PDB Update MSF File Documentation. 2018-01-12 21:42:39 +00:00
Proposals remove unreferenced footnotes 2018-01-05 00:24:55 +00:00
TableGen Improvements to TableGen/LangIntro.rst 2017-05-02 13:47:10 +00:00
_ocamldoc
_static Fix some typos in the doc 2016-08-28 20:29:18 +00:00
_templates
_themes/llvm-theme
tutorial [NFC] fix trivial typos in documents 2018-01-16 13:19:48 +00:00
AMDGPUUsage.rst fix invalid footnote syntax 2018-01-05 00:24:54 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AdvancedBuilds.rst
AliasAnalysis.rst [docs] AliasAnalysis: clarify that PartialAlias doesn't enforce 2017-07-15 09:09:24 +00:00
Atomics.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
Benchmarking.rst Add some tips on benchmarking. 2017-05-24 16:39:12 +00:00
BigEndianNEON.rst
BitCodeFormat.rst [NFC] fix trivial typos in documents 2018-01-16 13:19:48 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst [Doc] Document prof metadata in LangRef 2017-06-15 15:57:12 +00:00
Bugpoint.rst [docs] Mention opt -metarenamer in the bugpoint docs 2017-11-15 18:05:19 +00:00
CFIVerify.rst Introduce the llvm-cfi-verify tool (resubmission of D37937). 2017-09-20 20:38:14 +00:00
CMake.rst [tools] Add option to install binutils symlinks 2017-11-02 21:43:32 +00:00
CMakeLists.txt [dsymutil][doc] Improve wording in manpage and rename file. 2017-11-02 18:44:54 +00:00
CMakePrimer.rst [docs] In the CMake primer, correct the description of the ARGV/ARGN variables. 2017-08-24 05:38:39 +00:00
CodeGenerator.rst [MC] Fix -stack-size-section on ARM 2018-01-17 09:01:29 +00:00
CodeOfConduct.rst [Conduct] Refine what "rare cases" means wrt violations outside our spaces. 2016-07-06 19:32:41 +00:00
CodingStandards.rst Update some code.google.com links 2017-11-13 23:47:58 +00:00
CommandLine.rst Remove references to response file argument in CommandLine.rst 2017-09-20 22:41:34 +00:00
CompileCudaWithLLVM.rst [Docs] Update docs to indicate that CUDA compilation is supported on Windows. 2017-01-05 16:54:28 +00:00
CompilerWriterInfo.rst Fix broken links to the Itanium CXX ABI 2017-09-12 00:19:11 +00:00
Contributing.rst [Docs] Add Contributing page. 2018-01-04 17:12:21 +00:00
Coroutines.rst fix trivial typos in documents; NFC 2017-07-02 12:44:27 +00:00
CoverageMappingFormat.rst [Coverage] Use gap regions to select better line exec counts 2017-09-18 23:37:28 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Fixed broken links in docs. 2017-09-22 21:10:37 +00:00
Docker.rst Made a script to build docker images easier to use. 2017-07-06 12:46:51 +00:00
ExceptionHandling.rst [Doc] Guideline on adding exception handling support for a target 2018-01-24 09:53:01 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst [AArch64] Implement stack probing for windows 2017-12-20 06:51:45 +00:00
FAQ.rst fix some typos in the doc 2016-07-28 09:28:58 +00:00
FaultMaps.rst Fix the docs build 2017-02-07 20:36:03 +00:00
FuzzingLLVM.rst [llvm-opt-fuzzer] Introduce llvm-opt-fuzzer for fuzzing optimization passes 2017-11-10 12:19:08 +00:00
GarbageCollection.rst Tidy up example of getting the pointer size. 2016-10-14 05:45:46 +00:00
GetElementPtr.rst [docs] Update code block for compatibility with Sphinx 1.5.1 2017-11-06 11:47:24 +00:00
GettingStarted.rst docs/GettingStarted.rst: Update the list of release versions and tags 2017-11-30 23:47:30 +00:00
GettingStartedVS.rst [MC] Fix regression tests on Windows when git “core.autocrlf” is set to true. 2017-11-17 21:59:43 +00:00
GlobalISel.rst [globalisel] Add very brief docs summarizing the ISel part of the LLVMDev tutorial. 2017-10-23 17:18:44 +00:00
GoldPlugin.rst [docs] As of binutils 2.21.51.0.2, ld.bfd supports plugins too, represent this in docs 2017-06-23 13:54:10 +00:00
HowToAddABuilder.rst Added more info on silent master to the doc. 2017-07-05 20:45:44 +00:00
HowToBuildOnARM.rst
HowToCrossCompileBuiltinsOnArm.rst [docs][ARM] Add HowTo for cross compiling and testing compiler-rt builtins 2017-11-07 09:40:05 +00:00
HowToCrossCompileLLVM.rst [docs] Fix unexpected indentation in HowToCrossCompileLLVM.rst 2016-05-10 14:02:46 +00:00
HowToReleaseLLVM.rst docs: Fix formatting in HowToReleaseLLVM 2017-09-19 03:27:26 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst [docs] Fix mention of GCC frontend 2018-01-15 17:11:22 +00:00
HowToUseAttributes.rst Fix RST docs AttributeList heading underline 2017-03-21 17:05:00 +00:00
HowToUseInstrMappings.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
InAlloca.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
LLVMBuild.rst Fix LLVMBuild.txt typo. NFC 2017-04-03 18:21:50 +00:00
LLVMBuild.txt
LangRef.rst Additional fixes for docs in addition to r322968. 2018-01-19 17:32:33 +00:00
Lexicon.rst [Lexicon] Add "GEP" 2017-08-18 15:35:53 +00:00
LibFuzzer.rst [libFuzzer] add a flag -malloc_limit_mb 2017-12-01 22:12:04 +00:00
LinkTimeOptimization.rst [docs] Typos and whitespace fixed in LTO docs. 2016-11-29 18:00:31 +00:00
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
MIRLangRef.rst [MIR] Update MIRLangRef with documentation on bundled instructions 2018-01-10 17:53:16 +00:00
Makefile.sphinx
MarkedUpDisassembly.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
MemorySSA.rst Fix some typos in the doc 2016-08-28 20:29:18 +00:00
MergeFunctions.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
NVPTXUsage.rst [CodeGen] Unify MBB reference format in both MIR and debug output 2017-12-04 17:18:51 +00:00
OptBisect.rst Remove opt-bisect support for "cases" in favor of debug counters 2017-03-11 01:41:03 +00:00
Packaging.rst
Passes.rst Remove the ScalarReplAggregates pass 2016-06-15 00:19:09 +00:00
Phabricator.rst [docs] Tweak update to Phabricator docs about setting repository for diffs uploaded via web 2018-01-12 15:44:35 +00:00
ProgrammersManual.rst [docs] Use dbgs() instead of errs() for DEBUG() 2017-12-25 14:16:07 +00:00
Projects.rst
README.txt Remove test commit change. 2017-06-24 20:13:32 +00:00
ReleaseNotes.rst Clear release notes for 7.0.0 2018-01-03 15:45:32 +00:00
ReleaseProcess.rst [docs] Make ReleaseProcess.rst 80 column. NFCI 2018-01-18 14:57:55 +00:00
ReportingGuide.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
ScudoHardenedAllocator.rst [docs] Update Scudo documentation 2018-01-04 18:31:22 +00:00
SegmentedStacks.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
SourceLevelDebugging.rst [docs] Update code block for compatibility with Sphinx 1.5.1 2017-11-06 11:47:24 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [StackMaps] Increase the size of the "location size" field 2017-04-28 04:48:42 +00:00
Statepoints.rst [docs] change a few code-blocks to llvm from text 2017-07-26 14:11:23 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteMakefileGuide.rst
TestingGuide.rst Revert "lit.py: Add new %{shared_output(LABEL)} substitution" 2017-10-14 04:01:27 +00:00
TypeMetadata.rst Fixed broken links in docs. 2017-09-22 21:10:37 +00:00
Vectorizers.rst docs: Remove reference to a deprecated flag 2018-01-23 20:22:37 +00:00
WritingAnLLVMBackend.rst [Docs] Fix typo in scheduler model documentation. enumemation->enumeration 2017-12-10 09:14:35 +00:00
WritingAnLLVMPass.rst Fixed dead links in WritingAnLLVMPass.rst 2017-11-06 09:51:39 +00:00
XRay.rst [XRay][compiler-rt] Reduce XRay log spam 2017-12-13 06:37:13 +00:00
XRayExample.rst [XRay][compiler-rt] Reduce XRay log spam 2017-12-13 06:37:13 +00:00
XRayFDRFormat.rst [XRay][tools] Support tail-call exits before we write them in the runtime 2017-09-18 06:08:46 +00:00
YamlIO.rst [YAML] Add support for non-printable characters 2017-12-18 17:38:03 +00:00
conf.py The trunk version is now 7.0.0svn 2018-01-03 14:52:54 +00:00
doxygen-mainpage.dox
doxygen.cfg.in Sync with changes from r300825 in clang. 2017-04-27 17:23:53 +00:00
gcc-loops.png
index.rst [Docs] Add Contributing page. 2018-01-04 17:12:21 +00:00
linpack-pc.png
make.bat
re_format.7
yaml2obj.rst

README.txt

LLVM Documentation
==================

LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is mostly meant to be processed by the Sphinx documentation generation
system to create HTML pages which are hosted on <http://llvm.org/docs/> and
updated after every commit. Manpage output is also supported, see below.

If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make -j3 docs-llvm-html
    $BROWSER <build-dir>/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.

If you are interested in writing new documentation, you will want to read
`SphinxQuickstartTemplate.rst` which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.

Manpage Output
===============

Building the manpages is similar to building the HTML documentation. The
primary difference is to use the `man` makefile target, instead of the
default (which is `html`). Sphinx then produces the man pages in the
directory `<build-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make -j3 docs-llvm-man
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//man/Foo.1`.
These .rst files are also included during HTML generation so they are also
viewable online (as noted above) at e.g.
`http://llvm.org/docs/CommandGuide/Foo.html`.

Checking links
==============

The reachability of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck

Doxygen page Output
==============

Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.

    cd <build-dir>
    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
    make doxygen-llvm # for LLVM docs
    make doxygen-clang # for clang docs

It will generate html in
    
    <build-dir>/docs/doxygen/html # for LLVM docs
    <build-dir>/tools/clang/docs/doxygen/html # for clang docs