llvm-6502/docs
Richard Sandiford aae91f7df0 Merge of r181431
Add SystemZ feats to CodeGenerator.rst


git-svn-id: https://llvm.org/svn/llvm-project/llvm/branches/release_33@181432 91177308-0d34-0410-b5e6-96231b3b80d8
2013-05-08 14:26:00 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Documentation: end option description with a period 2013-04-27 16:34:24 +00:00
HistoricalNotes
TableGen Allow TableGen DAG arguments to be just a name. 2013-03-24 19:36:51 +00:00
tutorial Fix spelling 2013-05-01 13:05:43 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst Add basic zlib support to LLVM. This would allow to use compression/uncompression in selected LLVM tools. 2013-04-23 08:28:39 +00:00
CodeGenerator.rst Merge of r181431 2013-05-08 14:26:00 +00:00
CodingStandards.rst
CommandLine.rst Implemented public interface for modifying registered (not positional or sink options) command line options at runtime. 2013-05-06 21:56:35 +00:00
CompilerWriterInfo.rst Revert r181009. 2013-05-03 23:57:17 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst Grammar and punctuation fixes. 2013-04-15 17:38:06 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst fix include path in doc Extending LLVM 2013-04-15 03:26:13 +00:00
Extensions.rst MC: Support COFF image-relative MCSymbolRefs 2013-04-10 23:28:17 +00:00
FAQ.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst [SystemZ] Add configure bits 2013-05-06 16:22:34 +00:00
GettingStartedVS.rst Updating the getting started guide for Visual Studio users. Specifically, pointing out that you have to pass additional parameters to llvm-lit and explicitly specify python on the command line. 2013-05-01 19:13:50 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst [docs] Discuss a potential bug to be aware of. 2013-03-16 16:58:20 +00:00
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
index.rst MC: Support COFF image-relative MCSymbolRefs 2013-04-10 23:28:17 +00:00
LangRef.rst Remove comment that no target supports 128-bit IEEE floats 2013-05-03 14:32:27 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fix grammar in LLVMBuild.rst 2013-04-18 16:39:32 +00:00
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
MarkedUpDisassembly.rst
NVPTXUsage.rst Add start of user documentation for NVPTX 2013-03-30 16:41:14 +00:00
Packaging.rst
Passes.rst Missing word 2013-04-04 18:29:19 +00:00
Phabricator.rst
ProgrammersManual.rst [docs] The STL "binary search" has a non-obvious name. 2013-03-29 21:57:47 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst Merge of r181328 2013-05-08 13:51:45 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Formatting fixups. 2013-03-19 23:10:26 +00:00
SphinxQuickstartTemplate.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst fix small doc typo 2013-03-22 16:09:06 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Fix a grammar mistake, and add a line about the two phases that the BB/SLP vectorizers have (top-down and bottom-up). 2013-04-15 22:21:25 +00:00
WritingAnLLVMBackend.rst Give Sparc instruction patterns direct types instead of register classes. 2013-03-24 00:56:20 +00:00
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`.