llvm-6502/docs
Dmitri Gribenko edc399aceb docs/Passes: fix some typos
Patch by Yacine Belkadi.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@182197 91177308-0d34-0410-b5e6-96231b3b80d8
2013-05-18 18:01:44 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Add 'CHECK-DAG' support 2013-05-14 20:34:12 +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 docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Atomics.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
BitCodeFormat.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
BranchWeightMetadata.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Bugpoint.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 [SystemZ] Add disassembler support 2013-05-14 10:17:52 +00:00
CodingStandards.rst Coding standards: don't use `inline` when defining a function in a class 2013-02-04 10:24:58 +00:00
CommandLine.rst Better output for long help strings for command-line options. 2013-05-10 17:15:51 +00:00
CompilerWriterInfo.rst Revert r181009. 2013-05-03 23:57:17 +00:00
conf.py We're in 3.4 land now. 2013-05-07 20:31:28 +00:00
DebuggingJITedCode.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 Documentation: use monospaced font for intrinsics' names 2013-01-13 16:07:49 +00:00
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 docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
GarbageCollection.rst
gcc-loops.png Update the gcc-loops benchmark 2013-01-20 07:01:04 +00:00
GetElementPtr.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
HowToAddABuilder.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
HowToBuildOnARM.rst ARM build docs easier for copy&paste 2013-02-25 18:25:58 +00:00
HowToReleaseLLVM.rst Documentation: remove all mentions of DejaGNU and Tcl 2013-01-18 19:27:43 +00:00
HowToSetUpLLVMStyleRTTI.rst [docs] Discuss a potential bug to be aware of. 2013-03-16 16:58:20 +00:00
HowToSubmitABug.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
HowToUseAttributes.rst Documentation: HowToUseAttributes: formatting (use monospaced font) 2013-02-12 18:26:08 +00:00
HowToUseInstrMappings.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
index.rst MC: Support COFF image-relative MCSymbolRefs 2013-04-10 23:28:17 +00:00
LangRef.rst Correct logical shift documentation 2013-05-07 06:17:14 +00:00
Lexicon.rst [docs] PR15254: Add "AST" to the lexicon. 2013-02-13 21:17:20 +00:00
LinkTimeOptimization.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
linpack-pc.png Update the linpack benchmark with different array sizes. 2013-01-20 06:52:47 +00:00
LLVMBuild.rst Fix grammar in LLVMBuild.rst 2013-04-18 16:39:32 +00:00
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst Pass CPPFLAGS/CFLAGS/CXXFLAGS from the environment of configure to 2013-02-04 08:15:53 +00:00
MarkedUpDisassembly.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
NVPTXUsage.rst Add start of user documentation for NVPTX 2013-03-30 16:41:14 +00:00
Packaging.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Passes.rst docs/Passes: fix some typos 2013-05-18 18:01:44 +00:00
Phabricator.rst Update phab docs to clarify how to accept a change. 2013-02-13 09:07:18 +00:00
ProgrammersManual.rst [docs] The STL "binary search" has a non-obvious name. 2013-03-29 21:57:47 +00:00
Projects.rst Documentation: remove all mentions of DejaGNU and Tcl 2013-01-18 19:27:43 +00:00
re_format.7
README.txt [docs] Discuss manpage output. 2013-02-27 18:48:42 +00:00
ReleaseNotes_34.rst Remove exception handling support from the old JIT. 2013-05-07 20:53:59 +00:00
ReleaseNotes.rst Add Jade to the list of external projects using LLVM in the release notes. 2013-05-15 14:05:01 +00:00
SegmentedStacks.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
SourceLevelDebugging.rst Formatting fixups. 2013-03-19 23:10:26 +00:00
SphinxQuickstartTemplate.rst [docs] Provide pointer for building Sphinx docs. 2013-02-27 18:33:21 +00:00
SystemLibrary.rst
TableGenFundamentals.rst [docs] Guide prospective TableGen backend writers. 2013-01-30 20:39:46 +00:00
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 docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
YamlIO.rst Spelling corrections 2013-02-18 02:44:09 +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`.