llvm-6502/docs
2014-10-06 18:31:09 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide [LIT] Remove documentation for method since it does not exist 2014-08-21 18:52:58 +00:00
HistoricalNotes
TableGen Fix typo in TableGen documentation 2014-10-03 20:46:05 +00:00
tutorial
AliasAnalysis.rst
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst [sphinx cleanup] Fix unexpected indentation warning introduced by r218937 2014-10-03 12:28:48 +00:00
BigEndianNEON.rst
BitCodeFormat.rst Fix sphinx warning. 2014-09-18 21:54:02 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst Introduce -DLLVM_USE_SANITIZER=Undefined CMake option to build UBSan-ified version of LLVM/Clang. 2014-08-29 00:50:36 +00:00
CMakeLists.txt
CodeGenerator.rst [sphinx cleanup] 2014-09-10 20:43:03 +00:00
CodingStandards.rst CodingStandards: Document std::equal misbehaviour 2014-08-19 16:49:40 +00:00
CommandLine.rst
CompilerWriterInfo.rst Update documentation with link to Sea Islands documentation 2014-10-06 18:31:09 +00:00
conf.py Update LLVM version: 3.5 => 3.6 2014-07-28 22:10:52 +00:00
CoverageMappingFormat.rst Docs: add documentation for the coverage mapping format. 2014-08-19 17:05:58 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Document what backwards compatibility we provide for bitcode. 2014-07-23 22:43:22 +00:00
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 Remove the TargetMachine forwards for TargetSubtargetInfo based 2014-08-04 21:25:23 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Delete support for AuroraUX. 2014-08-14 15:15:09 +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 Add a reference to Phabricator.rst to docs/index.rst. 2014-10-03 20:17:32 +00:00
LangRef.rst [docs] Mention character array constants in docs/LangRef.rst 2014-09-11 12:02:59 +00:00
Lexicon.rst [docs] Document what "NFC" means in a commit message. 2014-09-06 00:19:16 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx Revert "Treat warnings in Sphinx as errors. The reasons for doing this are..." 2014-07-22 18:09:17 +00:00
MakefileGuide.rst
MarkedUpDisassembly.rst undo test commit (whitespace only) 2014-06-30 08:09:35 +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 Minor typo. 2014-09-05 04:56:43 +00:00
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 Update my previous commit to fit 80 cols... 2014-09-25 10:58:16 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst LTO: introduce object file-based on-disk module format. 2014-09-18 21:28:49 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst DI: Fixup global syntax in example 2014-10-04 15:44:01 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Reduce verbiage of lit.local.cfg files 2014-06-09 22:42:55 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Vectorization documentation for loop hint pragmas and Rpass diagnostics. 2014-06-27 18:30:08 +00:00
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