llvm-6502/docs
2014-04-03 07:08:21 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Remove LowerInvoke's obsolete "-enable-correct-eh-support" option 2014-03-20 19:54:47 +00:00
HistoricalNotes
TableGen Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
tutorial [docs] Clean up some more llvm-gcc stuff 2014-02-19 00:12:34 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst Remove the linker_private and linker_private_weak linkages. 2014-03-13 23:18:37 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst [docs] Teach CMake docs build how to generate Qt Creator help/documentation files. 2014-03-07 19:19:28 +00:00
CMakeLists.txt [docs] Teach CMake docs build how to generate Qt Creator help/documentation files. 2014-03-07 19:19:28 +00:00
CodeGenerator.rst [ms-cxxabi] Add a new calling convention that swaps 'this' and 'sret' 2014-01-31 17:41:22 +00:00
CodingStandards.rst C++11: Remove const from in auto guidelines 2014-03-07 18:06:15 +00:00
CommandLine.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CompilerWriterInfo.rst [docs] Add links to XMOS XCore documentation. 2014-03-14 15:53:50 +00:00
conf.py Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst [docs] Clean up some more llvm-gcc stuff 2014-02-19 00:12:34 +00:00
doxygen.cfg.in [docs] Teach CMake docs build how to generate Qt Creator help/documentation files. 2014-03-07 19:19:28 +00:00
doxygen.css
doxygen.footer Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst Exception handling docs: Clarify how the llvm.eh.* intrinsics are used 2014-03-28 17:08:57 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Fix typo 2014-02-15 06:02:36 +00:00
FAQ.rst remove an old entry whose link is broken anyway 2014-03-02 06:37:03 +00:00
GarbageCollection.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
gcc-loops.png
GetElementPtr.rst [docs] Clean up some more llvm-gcc stuff 2014-02-19 00:12:34 +00:00
GettingStarted.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
GettingStartedVS.rst Updating the getting started guide for Visual Studio a smidge. 2014-01-23 20:46:44 +00:00
GoldPlugin.rst Update the LTO GoldPlugin documentation 2013-12-02 07:15:33 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst [docs] Fix some Sphinx warnings. 2014-03-02 00:21:42 +00:00
HowToSetUpLLVMStyleRTTI.rst [C++11] Replace LLVM-style type traits with C++11 standard ones. 2014-03-07 14:42:25 +00:00
HowToSubmitABug.rst [docs] Nuke some references to llvm-gcc 2014-02-18 23:56:43 +00:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst inalloca: *Really* fix the docs 2014-03-27 01:38:48 +00:00
index.rst Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
LangRef.rst Prevent alias from pointing to weak aliases. 2014-03-27 15:26:56 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
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 Fix documentation typos 2013-12-20 00:33:39 +00:00
Packaging.rst
Passes.rst Remove LowerInvoke's obsolete "-enable-correct-eh-support" option 2014-03-20 19:54:47 +00:00
Phabricator.rst Docs: remove paragraph about manual account creation. 2014-03-10 19:24:30 +00:00
ProgrammersManual.rst "Mac OS/X" -> "Mac OS X" spelling fixes for llvm. 2014-03-07 18:08:54 +00:00
Projects.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
re_format.7
README.txt
ReleaseNotes.rst Update release notes with EHABI current behaviour 2014-03-24 11:02:38 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst Switch the type field in DIVariable and DIGlobalVariable over to DITypeRefs. 2014-03-18 02:34:58 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst Stack map docs. Remove some stray markup. 2014-04-03 07:08:21 +00:00
SystemLibrary.rst
TableGenFundamentals.rst Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
TestingGuide.rst Cleanup docs about lit substitutions 2014-02-15 08:35:56 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Fix whitespace in vectorizer example 2014-03-12 23:58:07 +00:00
WritingAnLLVMBackend.rst Add a RequireStructuredCFG Field to TargetMachine. 2013-12-07 01:49:19 +00:00
WritingAnLLVMPass.rst
yaml2obj.rst Object: rename ARMV7 to ARMNT 2014-03-11 03:08:37 +00:00
YamlIO.rst Fix documentation typos 2013-12-20 00:33:39 +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`.