llvm/docs
2016-12-26 23:42:12 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide
Frontend
HistoricalNotes
PDB Add documentation for the PDB Module Info stream. 2016-11-29 22:14:56 +00:00
Proposals
TableGen [Docs][TableGen] Remove reference to tablegen supporting octal integers. It doesn't and hasn't for at least 9 years. 2016-11-18 02:28:50 +00:00
tutorial
AdvancedBuilds.rst
AliasAnalysis.rst
AMDGPUUsage.rst
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
Bugpoint.rst
CMake.rst [doc] Add mention of the difference in optimization level between Release and RelWithDebInfo in Cmake.rst 2016-12-26 23:42:12 +00:00
CMakeLists.txt
CMakePrimer.rst
CodeGenerator.rst
CodeOfConduct.rst
CodingStandards.rst Fix some remaining documentation references to MSVC 2013 2016-12-15 19:08:02 +00:00
CommandLine.rst Update CommandLine.rst getRegisteredOptions example 2016-11-07 02:43:01 +00:00
CompileCudaWithLLVM.rst [CUDA] Note in docs that you need to build with -lcudart on MacOS 2016-11-22 23:13:29 +00:00
CompilerWriterInfo.rst [docs] fix link to AMD manuals (PR30946) 2016-11-08 16:49:24 +00:00
conf.py
Coroutines.rst
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen-mainpage.dox
doxygen.cfg.in
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Revert "[CodeGen] Fix invalid DWARF info on Win64" 2016-12-08 01:56:23 +00:00
FAQ.rst
FaultMaps.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Fix some remaining documentation references to MSVC 2013 2016-12-15 19:08:02 +00:00
GettingStartedVS.rst [doc] Remove explicit CMake version requirement for MSVC 2016-11-09 01:44:42 +00:00
GlobalISel.rst [docs] Add initial Global ISel documentation. 2016-11-04 17:57:34 +00:00
GoldPlugin.rst Revert 'Test commit as per developer policy' 2016-11-30 08:24:43 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst [PDB] Begin adding documentation for the PDB file format. 2016-11-10 19:24:21 +00:00
LangRef.rst [DebugInfo] Added support for Checksum debug info feature. 2016-12-25 10:12:09 +00:00
Lexicon.rst
LibFuzzer.rst [libFuzzer] doc update 2016-12-15 18:47:22 +00:00
LinkTimeOptimization.rst [docs] Typos and whitespace fixed in LTO docs. 2016-11-29 18:00:31 +00:00
linpack-pc.png
LLVMBuild.rst Test commit. 2016-12-24 17:26:38 +00:00
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
OptBisect.rst
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst Fix missing '>' in docs (hopefully fixes bot error... ) 2016-12-20 17:43:48 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Timer: Track name and description. 2016-11-18 19:43:18 +00:00
ReleaseProcess.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst
SegmentedStacks.rst
SourceLevelDebugging.rst [docs] Fix some typos. NFC. 2016-11-01 23:55:50 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst
TestSuiteMakefileGuide.rst
TypeMetadata.rst
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
XRay.rst [XRay][docs] Define requirements on installed log handlers. 2016-11-16 02:18:23 +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