llvm-6502/docs
2015-06-25 23:40:15 +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 [PerformanceTips] Italics are *word*, not _word_ 2015-04-26 22:25:29 +00:00
HistoricalNotes
TableGen [TableGen] Correct the documentation for 'foreach' in the Language Intro. 2015-06-06 00:44:42 +00:00
tutorial IR: Give 'DI' prefix to debug info metadata 2015-04-29 16:38:44 +00:00
AliasAnalysis.rst [PM/AA] Hoist the AliasResult enum out of the AliasAnalysis class. 2015-06-22 02:16:51 +00:00
AMDGPUUsage.rst R600 -> AMDGPU rename 2015-06-13 03:28:10 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
BigEndianNEON.rst
BitCodeFormat.rst Move the personality function from LandingPadInst to Function 2015-06-17 20:52:32 +00:00
BitSets.rst
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst Add function entry count metadata. 2015-05-13 15:13:45 +00:00
Bugpoint.rst Correct 'teh' and other typos / repeated words. 2015-04-14 20:52:58 +00:00
BuildingLLVMWithAutotools.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
CMake.rst docs: Update allowed values for LLVM_USE_SANITIZER 2015-06-22 18:55:46 +00:00
CMakeLists.txt
CodeGenerator.rst
CodingStandards.rst Doxygen: Enable autobrief feature and update coding standards. 2015-05-15 03:34:01 +00:00
CommandLine.rst
CompilerWriterInfo.rst R600 -> AMDGPU rename 2015-06-13 03:28:10 +00:00
conf.py
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst docs: Fix up some .rst formatting 2015-05-14 23:56:58 +00:00
doxygen.cfg.in Doxygen: Enable autobrief feature and update coding standards. 2015-05-15 03:34:01 +00:00
doxygen.intro
Dummy.html
ExceptionHandling.rst [WinEH] Sink UnwindHelp completely out of IR 2015-04-03 22:32:26 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst [docs] Update outdated ExtendingLLVM.rst 2015-04-13 16:04:17 +00:00
Extensions.rst Use a comma after the unique keyword. 2015-04-06 16:34:41 +00:00
FAQ.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
FaultMaps.rst [NFC] Capitalization in documentation. 2015-06-22 18:02:55 +00:00
GarbageCollection.rst Document the CoreCLR GC Strategy 2015-05-21 00:50:10 +00:00
gcc-loops.png
GetElementPtr.rst Update LangRef for getelementptr explicit type changes 2015-03-04 22:02:58 +00:00
GettingStarted.rst R600 -> AMDGPU rename 2015-06-13 03:28:10 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst Unbreak docs build from r239740. 2015-06-15 19:38:15 +00:00
LangRef.rst [docs] Fix "WARNING: Title underline too short." 2015-06-17 21:21:16 +00:00
Lexicon.rst [docs] Document "LGTM" in the lexicon. 2015-06-04 20:28:09 +00:00
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 [docs] Update the doxygen configuration file. 2015-03-12 17:26:27 +00:00
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 Inspired by r231891, use gender neutral pronouns in the places I've 2015-03-11 00:15:44 +00:00
NVPTXUsage.rst [docs] fix the declarations of the llvm.nvvm.ptr.gen.to.* intrinsics 2015-05-29 22:18:03 +00:00
Packaging.rst
Passes.rst
Phabricator.rst Add some more detailed docs about the current state of Phabricator and 2015-05-27 07:20:46 +00:00
ProgrammersManual.rst Fix documentation for Set-Like Containers 2015-05-19 10:21:12 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Update 3.7 Release Note mentionning the non-optionality of the DataLayout 2015-03-18 22:01:44 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst Fixed some typos and broken links in source level debugging docs. 2015-05-14 10:58:59 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst [Statepoints][Docs] Fix a couple of out of date examples. 2015-05-13 20:20:10 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Document some of the options in test/lit.cfg 2015-05-04 21:37:00 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Correct 'teh' and other typos / repeated words. 2015-04-14 20:52:58 +00:00
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
yaml2obj.rst
YamlIO.rst [YAMLIO] Make line-wrapping configurable and test it. 2015-05-29 17:56:28 +00:00

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