llvm-6502/docs
2015-07-14 23:29:53 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Make llvm-dwarfdump exit with non-zero exit code if error was occured. 2015-06-25 23:40:15 +00:00
Frontend
HistoricalNotes
TableGen
tutorial
AliasAnalysis.rst [PM/AA] Hoist the AliasResult enum out of the AliasAnalysis class. 2015-06-22 02:16:51 +00:00
AMDGPUUsage.rst AMDGPU/SI: Update amd_kernel_code_t definition and add assembler support 2015-06-26 21:58:31 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
BigEndianNEON.rst
BitCodeFormat.rst
BitSets.rst
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
Bugpoint.rst
BuildingLLVMWithAutotools.rst
CMake.rst docs: Update allowed values for LLVM_USE_SANITIZER 2015-06-22 18:55:46 +00:00
CMakeLists.txt
CodeGenerator.rst [NFC] Minor editorial fixes to the CodeGen docs. 2015-07-02 09:32:01 +00:00
CodingStandards.rst
CommandLine.rst
CompilerWriterInfo.rst
conf.py Update the trunk version to 3.8.0svn. 2015-07-14 22:35:57 +00:00
CoverageMappingFormat.rst Fix Sphinx error about duplicate label in CommandLine.rst:1560 and CoverageMappingFormat.rst 2015-07-14 23:29:53 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen.cfg.in
doxygen.intro
Dummy.html
ExceptionHandling.rst Rename llvm.frameescape and llvm.framerecover to localescape and localrecover 2015-07-07 22:25:32 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
FaultMaps.rst [FaultMaps] Let the frontend pre-select implicit null check candidates. 2015-06-30 21:22:32 +00:00
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Getting started docs: https, and check signature 2015-07-01 03:32:08 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst
LangRef.rst [mips] Explained the 'w' modifier in the Inline Assembler documentation. 2015-07-13 09:24:21 +00:00
Lexicon.rst
LibFuzzer.rst Fix "the the" in comments. 2015-06-19 01:53:21 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
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
MergeFunctions.rst
NVPTXUsage.rst
Packaging.rst
Passes.rst
Phabricator.rst Expand Phabricator docs slightly 2015-07-01 13:41:18 +00:00
ProgrammersManual.rst Fix PR24099 reported by Tomas Brukner. 2015-07-12 20:40:41 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst ReleaseNotes.rst: Bump version to 3.8 2015-07-14 22:49:27 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.rst [PowerPC] Use the ABI indirect-call protocol for patchpoints 2015-07-14 22:26:06 +00:00
Statepoints.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst
TestSuiteMakefileGuide.rst
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
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 docs/
    make -f Makefile.sphinx
    $BROWSER _build/html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `_build/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/man/`.

    cd docs/
    make -f Makefile.sphinx man
    man -l _build/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `_build/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 reachibility of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck