llvm-project/llvm/docs
Sylvestre Ledru 751e0bb6af Explicit in the doc the current list of projects (with easy copy and paste)
llvm-svn: 375339
2019-10-19 09:55:24 +00:00
..
AMDGPU [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
CommandGuide [llvm-objcopy] Add support for shell wildcards 2019-10-17 20:51:00 +00:00
DependenceGraphs Data Dependence Graph Basics 2019-09-18 17:43:45 +00:00
Frontend [docs] Remove training whitespaces. NFC 2019-09-20 15:02:32 +00:00
HistoricalNotes
PDB Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
Proposals Fix the spelling of my name. 2019-10-07 22:55:42 +00:00
TableGen [docs] Fix TableGen/LangRef typos 2019-06-13 18:42:30 +00:00
_ocamldoc
_static
_templates [Docs] Updates sidebar links and sets max-width property for div.body 2019-10-15 21:27:20 +00:00
_themes/llvm-theme [Docs] Updates sidebar links and sets max-width property for div.body 2019-10-15 21:27:20 +00:00
tutorial Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
AMDGPUInstructionNotation.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2018-12-28 11:48:23 +00:00
AMDGPUInstructionSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-07-08 16:50:11 +00:00
AMDGPUModifierSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2019-09-25 12:38:35 +00:00
AMDGPUUsage.rst [AMDGPU] gfx908 target 2019-07-09 18:10:06 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AddingConstrainedIntrinsics.rst [FPEnv] A missing crucial step was undocumented. 2019-06-25 16:09:39 +00:00
AdvancedBuilds.rst Use backquotes to avoid a sphinx unexpected error: 2018-12-16 14:19:39 +00:00
AliasAnalysis.rst [doc] Removed obsolete -count-aa from AliasAnalysis documentation 2018-04-23 13:45:28 +00:00
Atomics.rst [NFC] Test commit, deleting some whitespace 2019-09-20 09:43:31 +00:00
Benchmarking.rst
BigEndianNEON.rst
BitCodeFormat.rst [X86] Add new calling convention that guarantees tail call optimization 2019-10-07 22:28:58 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst [TI removal] Remove discussion of `TerminatorInst` from the LLVM 2018-10-18 07:40:24 +00:00
BugLifeCycle.rst Introduce bug life cycle documentation. 2018-11-07 08:49:36 +00:00
Bugpoint.rst Reland "[docs][Bugpoint]Add notes about multiple crashes" 2019-09-17 21:09:41 +00:00
BugpointRedesign.md [Bugpoint redesign] Fix nonlocal URI link in doc 2019-08-09 21:48:47 +00:00
BuildingADistribution.rst Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
CFIVerify.rst [cfi-verify] Abort on unsupported targets 2018-07-16 15:26:44 +00:00
CMake.rst Explicit in the doc the current list of projects (with easy copy and paste) 2019-10-19 09:55:24 +00:00
CMakeLists.txt
CMakePrimer.rst
CodeGenerator.rst [X86] Add new calling convention that guarantees tail call optimization 2019-10-07 22:28:58 +00:00
CodeOfConduct.rst
CodingStandards.rst Move to C++14 2019-08-14 17:39:07 +00:00
CommandLine.rst [NFC] fix trivial typos in documents 2019-06-25 07:24:27 +00:00
CompileCudaWithLLVM.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
CompilerWriterInfo.rst [PowerPC][docs] Update IBM official docs in Compiler Writers Info page 2019-10-10 19:25:30 +00:00
Contributing.rst [Docs] Fixes broken sphinx build - undefined label 2019-10-08 22:45:20 +00:00
Coroutines.rst Extend coroutines to support a "returned continuation" lowering. 2019-08-14 03:53:17 +00:00
CoverageMappingFormat.rst
DebuggingJITedCode.rst [Docs] Modernize references to macOS 2019-05-30 16:46:22 +00:00
DeveloperPolicy.rst docs/DeveloperPolicy: Add instructions for requesting GitHub commit access 2019-10-10 23:36:06 +00:00
Docker.rst [build] Rename clang-headers to clang-resource-headers 2019-03-04 21:19:53 +00:00
ExceptionHandling.rst [NFC] fix trivial typos in documents and comments 2018-04-12 05:53:20 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst Note ImmArg in documentation for adding intrinsics 2019-03-14 13:46:17 +00:00
Extensions.rst Add IR support, ELF section and user documentation for partitioning feature. 2019-05-29 03:29:01 +00:00
FAQ.rst Update the FAQ: remove stuff related to the previous license + 2019-10-03 09:43:54 +00:00
FaultMaps.rst
FuzzingLLVM.rst [docs] Try to clarify the FuzzingLLVM docs 2018-08-16 21:55:09 +00:00
GarbageCollection.rst [GC docs] Update the gcroot documentation to reflect recent simplifcations to GCStrategy configurability 2018-11-12 20:30:50 +00:00
GetElementPtr.rst [DOC] Fix `load` instructions' syntax, function definition. 2019-06-12 11:24:22 +00:00
GettingInvolved.rst [Docs] Moves Reference docs to new page 2019-09-25 00:49:02 +00:00
GettingStarted.rst [docs] Fix sphinx doc generation errors 2019-08-14 22:18:01 +00:00
GettingStartedTutorials.rst [Docs] Adds Documentation links to sidebar 2019-10-09 20:26:13 +00:00
GettingStartedVS.rst Retire VS2015 Support 2019-07-09 10:10:48 +00:00
GlobalISel.rst [docs] Fix sphinx doc generation errors 2019-08-14 22:18:01 +00:00
GoldPlugin.rst [docs][gold] Fix a typo 2018-08-21 21:00:54 +00:00
GwpAsan.rst [docs] Add GwpAsan to toctree. 2019-08-21 18:31:03 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToBuildWithPGO.rst HowToBuildWithPGO.rst: Fix a few details in the manual steps 2018-12-05 08:35:30 +00:00
HowToCrossCompileBuiltinsOnArm.rst [docs] Improve HowToCrossCompilerBuiltinsOnArm 2018-12-18 12:40:19 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst Remove some autoconf references from docs and comments 2019-07-03 09:57:59 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst [docs] Prevent O0 optnone for opt input 2019-01-29 22:17:51 +00:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
LLVMBuild.rst
LLVMBuild.txt Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
LangRef.rst Update docs for fast-math flags. 2019-10-18 16:07:09 +00:00
Lexicon.rst Update the coding standards and developer policy documentation surrounding whitespace. 2018-08-10 17:26:07 +00:00
LibFuzzer.rst [docs] Update structure-aware-fuzzing link. 2019-09-20 19:39:50 +00:00
LinkTimeOptimization.rst
LoopTerminology.rst [docs] Fix sphinx doc generation errors 2019-08-14 22:18:01 +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 [LLVM][Alignment] Make functions using log of alignment explicit 2019-09-05 10:00:22 +00:00
Makefile.sphinx
MarkdownQuickstartTemplate.md [docs] Reinstate r337730 - Add support for Markdown documentation in 2018-08-06 00:38:31 +00:00
MarkedUpDisassembly.rst
MeetupGuidelines.rst Add guidelines/recommendations for organizers of LLVM Socials 2019-05-14 07:20:58 +00:00
MemorySSA.rst [NFC] fix trivial typos in comments and documents 2018-01-26 08:15:29 +00:00
MergeFunctions.rst Updating MergeFunctions.rst 2018-08-18 20:17:19 +00:00
NVPTXUsage.rst
ORCv2.rst Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
OptBisect.rst [Docs] Remove hard tab character from code block in optbisect documentation 2018-07-27 06:54:13 +00:00
Packaging.rst
Passes.rst [Unroll/UnrollAndJam/Vectorizer/Distribute] Add followup loop attributes. 2018-12-12 17:32:52 +00:00
Phabricator.rst Update GettingStarted guide to recommend that people use the new 2019-01-14 22:27:32 +00:00
ProgrammersManual.rst Fix typo in programmer's manual cantFile -> cantFail 2019-07-18 05:24:22 +00:00
Projects.rst
README.txt [NFC] Test commit, whitespace change 2019-06-06 22:07:14 +00:00
Reference.rst [Docs] Moves Control Flow Document to User Guides 2019-10-13 20:05:22 +00:00
ReleaseNotes.rst Update ReleaseNotes: expand the section on enabling MemorySSA 2019-10-16 21:52:09 +00:00
ReleaseProcess.rst [ReleaseProcess] Document requirement to set MACOSX_DEPLOYMENT_TARGET 2019-10-01 17:10:45 +00:00
Remarks.rst Reland: [Remarks] Add an LLVM-bitstream-based remark serializer 2019-07-31 00:13:51 +00:00
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs] Scudo: document error messages & their potential cause 2019-01-22 16:43:45 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Update link to the DWARF spec. 2019-09-11 19:57:29 +00:00
SpeculativeLoadHardening.md Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [docs] Clarify ELF section naming for StackMaps and fix a typo 2018-11-08 17:20:35 +00:00
StackSafetyAnalysis.rst Remove trailing empty line 2018-11-26 23:17:52 +00:00
Statepoints.rst [docs][statepoints] Reformulate open issues list 2018-11-09 17:09:16 +00:00
SupportLibrary.rst [Docs] [Support] Correct a missed reference and use up to date .inc examples. 2018-09-21 01:53:51 +00:00
SystemLibrary.rst [Docs] [Support] System Library to Support Library transition along with minor corrections to reflect it. 2018-09-18 18:05:38 +00:00
TableGenFundamentals.rst
TestSuiteGuide.md Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TestSuiteMakefileGuide.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TestingGuide.rst [Docs] Test commit 2019-08-18 19:07:10 +00:00
TransformMetadata.rst [Unroll/UnrollAndJam/Vectorizer/Distribute] Add followup loop attributes. 2018-12-12 17:32:52 +00:00
TypeMetadata.rst Reland: Dead Virtual Function Elimination 2019-10-17 09:58:57 +00:00
UserGuides.rst [Docs] Moves Control Flow Document to User Guides 2019-10-13 20:05:22 +00:00
Vectorizers.rst Update GettingStarted guide to recommend that people use the new 2019-01-14 22:27:32 +00:00
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst Attempt to unbreak sphinx build bot by inserting a link. 2019-07-31 22:14:26 +00:00
XRay.rst [Docs] Update of Xray page 2018-07-26 04:44:31 +00:00
XRayExample.rst [XRay][docs] Fix option name 2019-03-12 13:44:42 +00:00
XRayFDRFormat.rst Tidy some language in the xray documentation. 2018-05-27 09:19:03 +00:00
YamlIO.rst [Docs] Fix LLVM_YAML_IS_DOCUMENT_LIST_VECTOR 2018-07-23 14:17:43 +00:00
conf.py [Docs] Add a custom sidebar to doc pages 2019-09-20 22:16:39 +00:00
doxygen-mainpage.dox
doxygen.cfg.in [NFC] Remove LLVM_ALIGNAS 2019-07-31 03:22:08 +00:00
gcc-loops.png
index.rst [Docs] Removes Subsystem Documentation page 2019-10-06 22:49:22 +00:00
linpack-pc.png
llvm-objdump.1 Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
make.bat
re_format.7
speculative_load_hardening_microbenchmarks.png [x86/SLH] Add the design document for Speculative Load Hardening, 2018-07-18 14:05:14 +00:00
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