llvm-6502/docs
2014-12-05 11:06:13 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Merging r214331: 2014-07-30 22:43:59 +00:00
HistoricalNotes
TableGen Fix Sphinx warnings. 2014-07-21 16:39:00 +00:00
tutorial
AliasAnalysis.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 Add information about new CMake interface to LLVM and note 2014-07-28 14:04:39 +00:00
CMakeLists.txt
CodeGenerator.rst [docs] Fix a mangled sentence. 2014-07-01 18:22:32 +00:00
CodingStandards.rst Remove the recommendation against using std::function 2014-07-02 00:42:07 +00:00
CommandLine.rst
CompilerWriterInfo.rst
conf.py Fix the version in the doc generation 2014-07-25 10:16:56 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
GarbageCollection.rst Fix 'platform-specific' hyphenations 2014-06-30 18:57:16 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Drop the udis86 wrapper from llvm::sys 2014-07-17 20:05:29 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst docs: Update relaease documents to include the patch number in the RELEASE tags 2014-07-21 14:28:31 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst
LangRef.rst Update lang ref. 2014-09-02 21:21:48 +00:00
Lexicon.rst fixed link 2014-07-14 19:52:36 +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
NVPTXUsage.rst
Packaging.rst
Passes.rst
Phabricator.rst Phabricator doc: Explicit the fact that the patch needs to be there before the commit 2014-07-04 09:00:35 +00:00
ProgrammersManual.rst Revert "[C++11] Add predecessors(BasicBlock *) / successors(BasicBlock *) iterator ranges." 2014-07-21 17:06:51 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Add the big-endian O32 small structures bugfix to the Mips release notes. 2014-12-05 11:06:13 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.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