llvm-6502/docs
Rafael Espindola bb0e2be6a3 Use Field Lists for the types' "Overview", "Syntax" and "Examples".
Thanks to Sean Silva for the suggestion.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@196924 91177308-0d34-0410-b5e6-96231b3b80d8
2013-12-10 14:53:22 +00:00
..
_static [docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx. 2012-04-19 20:20:34 +00:00
_templates [docs] Convert docs index page into Sphinx. 2012-04-19 16:31:37 +00:00
_themes/llvm-theme Sphinx CSS: remove negative letter-spacing, it makes some fonts look really 2012-09-30 20:43:24 +00:00
CommandGuide Remove dangling documentation. llvm-prof was deleted a while ago. 2013-11-21 19:32:37 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen Allow TableGen DAG arguments to be just a name. 2013-03-24 19:36:51 +00:00
tutorial [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst 2013-11-05 12:14:04 +00:00
AliasAnalysis.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Atomics.rst Small correction to unordered memory code generation of ARM LDRD 2013-06-18 23:07:16 +00:00
BitCodeFormat.rst Implement function prefix data as an IR feature. 2013-09-16 01:08:15 +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 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 [docs] Add link to 32-bit ARM ELF supplement. 2013-11-04 19:43:36 +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 Developer policy amendment regarding confidentiality notices 2013-10-18 08:45:43 +00:00
doxygen.cfg.in [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
doxygen.css [docs] Update Makefile for images removal. 2012-04-20 17:27:12 +00:00
doxygen.footer Update the copyright coredits -- Happy new year 2013! 2013-01-01 10:00:19 +00:00
doxygen.header Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
doxygen.intro Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
Dummy.html Add a dummy documentation file to unbreak 'make install'. We need to find how 2012-12-13 13:37:35 +00:00
ExceptionHandling.rst Documentation: use monospaced font for intrinsics' names 2013-01-13 16:07:49 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +00:00
Extensions.rst Support multiple COFF sections with the same name but different COMDAT. 2013-11-19 19:52:52 +00:00
FAQ.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
GarbageCollection.rst Remove reference to obsolete arguments. 2013-10-18 23:11:25 +00:00
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 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 docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 Typo 2013-05-28 11:28:37 +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 [docs] Fix some Sphinx toctree warnings. 2013-09-09 19:09:00 +00:00
LangRef.rst Use Field Lists for the types' "Overview", "Syntax" and "Examples". 2013-12-10 14:53:22 +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 LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
make.bat [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
Makefile docs: Remove incompatibility with Solaris shell 2013-10-15 08:30:07 +00:00
Makefile.sphinx Makefile.sphinx: reST conversion is complete! 2012-12-12 21:35:43 +00:00
MakefileGuide.rst Remove stray '_'. 2013-10-28 21:43:54 +00:00
MarkedUpDisassembly.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 [NVPTX] Fix type in usage doc 2013-11-15 16:08:49 +00:00
Packaging.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
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 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.rst Update to reflect the next release. 2013-11-20 10:10:50 +00:00
ReleaseProcess.rst Update Release Process doc 2013-06-12 11:35:33 +00:00
SegmentedStacks.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
SourceLevelDebugging.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
SphinxQuickstartTemplate.rst [docs] Provide pointer for building Sphinx docs. 2013-02-27 18:33:21 +00:00
SystemLibrary.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
TableGenFundamentals.rst [docs] Guide prospective TableGen backend writers. 2013-01-30 20:39:46 +00:00
TestingGuide.rst Update the Python version. And Perl isn't used anymore. 2013-10-27 04:02:21 +00:00
TestSuiteMakefileGuide.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
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 YAML I/O add support for validate() 2013-11-21 00:28:07 +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`.