llvm/docs
2017-03-22 18:01:01 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide Resubmit r297897: [PGO] Value profile for size of memory intrinsic calls 2017-03-16 21:15:48 +00:00
Frontend
HistoricalNotes
PDB
Proposals
TableGen [X86][AVX512] Adding new LLVM TableGen backend which generates the EVEX2VEX compressing tables. 2017-03-07 08:11:19 +00:00
tutorial Remove redundant code block and update comment. 2017-03-04 14:00:44 +00:00
AdvancedBuilds.rst
AliasAnalysis.rst
AMDGPUUsage.rst [DebugInfo] Emit address space with DW_AT_address_class attribute for pointer and reference types 2017-03-08 23:55:44 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
BigEndianNEON.rst
BitCodeFormat.rst
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst Add function importing info from samplepgo profile to the module summary. 2017-02-28 18:09:44 +00:00
Bugpoint.rst
CMake.rst
CMakeLists.txt
CMakePrimer.rst
CodeGenerator.rst [docs] Fix typo 2017-02-09 23:02:37 +00:00
CodeOfConduct.rst
CodingStandards.rst
CommandLine.rst
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst
conf.py docs/conf.py: Suppress sphinx highlighting failure warnings 2017-02-10 00:00:22 +00:00
Coroutines.rst [coroutines] Add handling for unwind coro.ends 2017-03-07 21:00:54 +00:00
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
doxygen-mainpage.dox
doxygen.cfg.in
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Make it possible to set SHF_LINK_ORDER explicitly. 2017-02-09 14:59:20 +00:00
FAQ.rst
FaultMaps.rst Fix the docs build 2017-02-07 20:36:03 +00:00
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Mention that the Sphinx docs build wants version 1.5 or later 2017-03-20 17:49:36 +00:00
GettingStartedVS.rst
GlobalISel.rst
GoldPlugin.rst
HowToAddABuilder.rst [docs] Document the staging buildbot 2017-02-05 21:21:23 +00:00
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
HowToUseAttributes.rst Fix RST docs AttributeList heading underline 2017-03-21 17:05:00 +00:00
HowToUseInstrMappings.rst
InAlloca.rst
index.rst
LangRef.rst Document the status quo of DIExpression semantics in LangRef.rst 2017-03-22 18:01:01 +00:00
Lexicon.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
LibFuzzer.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile.sphinx
MarkedUpDisassembly.rst
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst
MemorySSA.rst
MergeFunctions.rst
MIRLangRef.rst
NVPTXUsage.rst Update NVVMReflect usage doc to new idiom for adding target-specific early passes. 2017-01-27 19:44:24 +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
Phabricator.rst
ProgrammersManual.rst Fix some indenting and line-wrapping issues identified in ProgrammersManual. Make description of debugCounters a little clearer 2017-03-13 19:09:23 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Don't try to link to the 4.0 release notes 2017-02-09 23:03:34 +00:00
ReleaseProcess.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs] Documentation update for Scudo 2017-02-09 16:07:52 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst [docs] cleanup documentation on lit substitutions 2017-02-09 14:12:30 +00:00
TestSuiteMakefileGuide.rst
TypeMetadata.rst
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
XRay.rst [XRay][Docs] Update the XRay documentation 2017-02-28 22:01:26 +00:00
yaml2obj.rst
YamlIO.rst

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