llvm-6502/docs
Alexey Samsonov 8d54670b85 Remove link to unexisting llvm-prof docs
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@197989 91177308-0d34-0410-b5e6-96231b3b80d8
2013-12-24 19:58:49 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Remove link to unexisting llvm-prof docs 2013-12-24 19:58:49 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen
tutorial [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst 2013-11-05 12:14:04 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst Implement function prefix data as an IR feature. 2013-09-16 01:08:15 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst CMake : optionaly enable LLVM to be compiled with -std=c++11 (default: off) 2013-11-26 10:33:53 +00:00
CMakeLists.txt [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
CodeGenerator.rst Add more documentation about the TargetStreamer interface. 2013-10-16 14:54:39 +00:00
CodingStandards.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CommandLine.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CompilerWriterInfo.rst Update the links to the SPARC information. 2013-12-19 20:54:33 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst Developer policy amendment regarding confidentiality notices 2013-10-18 08:45:43 +00:00
doxygen.cfg.in Fix documentation typos 2013-12-20 00:33:39 +00:00
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst [COFF] Add support for the .secidx directive 2013-12-20 18:15:00 +00:00
FAQ.rst
GarbageCollection.rst Remove reference to obsolete arguments. 2013-10-18 23:11:25 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Update the Python version. And Perl isn't used anymore. 2013-10-27 04:02:21 +00:00
GettingStartedVS.rst [typo] An LLVM. 2013-08-16 23:30:19 +00:00
GoldPlugin.rst Update the LTO GoldPlugin documentation 2013-12-02 07:15:33 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst Adding some info about stability of ARM boards 2013-11-15 08:42:14 +00:00
HowToCrossCompileLLVM.rst [docs] Some typographical fixes. 2013-09-09 19:05:03 +00:00
HowToReleaseLLVM.rst Add ARM to release instructions 2013-12-13 09:39:36 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst Begin adding docs and IR-level support for the inalloca attribute 2013-12-19 02:14:12 +00:00
index.rst LangRef documentation for the stackmap and patchpoint intrinsics. 2013-12-24 02:57:25 +00:00
LangRef.rst LangRef documentation for the stackmap and patchpoint intrinsics. 2013-12-24 02:57:25 +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 docs: Remove incompatibility with Solaris shell 2013-10-15 08:30:07 +00:00
Makefile.sphinx
MakefileGuide.rst Remove stray '_'. 2013-10-28 21:43:54 +00:00
MarkedUpDisassembly.rst
MCJIT-creation.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-dyld-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-engine-builder.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load-object.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-resolve-relocations.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJITDesignAndImplementation.rst Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
NVPTXUsage.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
Packaging.rst
Passes.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Phabricator.rst Update of the 'Code Review' page. The link is now called 'Create Diff' instead of 'Create Revision' 2013-11-11 14:27:56 +00:00
ProgrammersManual.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Update to reflect the next release. 2013-11-20 10:10:50 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst LangRef documentation for the stackmap and patchpoint intrinsics. 2013-12-24 02:57:25 +00:00
SystemLibrary.rst
TableGenFundamentals.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
TestingGuide.rst Update the Python version. And Perl isn't used anymore. 2013-10-27 04:02:21 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Update the docs. 2013-08-05 04:27:34 +00:00
WritingAnLLVMBackend.rst Add a RequireStructuredCFG Field to TargetMachine. 2013-12-07 01:49:19 +00:00
WritingAnLLVMPass.rst fix RST reference in Writing an LLVM Pass 2013-10-30 17:09:32 +00:00
yaml2obj.rst Fix common typos in the docs. 2013-10-29 17:53:27 +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`.