llvm-6502/docs
Alexey Samsonov f27b46b26f Document LLVM_USE_SANITIZER CMake option
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@185925 91177308-0d34-0410-b5e6-96231b3b80d8
2013-07-09 10:56:13 +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 llvm-symbolizer: add support for Mach-O universal binaries 2013-06-28 08:15:40 +00:00
HistoricalNotes Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
TableGen Allow TableGen DAG arguments to be just a name. 2013-03-24 19:36:51 +00:00
tutorial [docs] Fix broken link. 2013-06-21 01:11:52 +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 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 Document LLVM_USE_SANITIZER CMake option 2013-07-09 10:56:13 +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 Add a Subtarget feature 'v8fp' to the ARM backend. 2013-06-27 11:49:26 +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 Reapply r141657. 2011-10-31 23:46:50 +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 MC: Implement COFF .linkonce directive 2013-07-06 12:13:10 +00:00
FAQ.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
GarbageCollection.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +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 Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +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 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 Linking ReleaseProcess doc with the world 2013-05-28 10:32:55 +00:00
LangRef.rst Fix language. 2013-07-06 01:04:47 +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 POD based man page docs (and build system support). 2012-05-08 17:48:21 +00:00
Makefile.sphinx Makefile.sphinx: reST conversion is complete! 2012-12-12 21:35:43 +00:00
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 IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +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 Add a release note for removing the simplify-libcalls pass. 2013-06-21 03:08:23 +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 Debug Info: Update documentation to match recent (& not so recent) schema changes 2013-05-29 02:05:13 +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 Add platform specific tests doc 2013-07-03 20:56:33 +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 The SLP Vectorizer works across basic blocks. Update the docs. 2013-06-26 17:59:35 +00:00
WritingAnLLVMBackend.rst [docs] Amend confusing title 2013-07-01 20:45:12 +00:00
WritingAnLLVMPass.rst IR headers moved to llvm/IR some aeons ago, update documentation. 2013-07-08 19:59:35 +00:00
yaml2obj.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
YamlIO.rst [docs] Replace non-existent LLVM_YAML_UNIQUE_TYPE() macro 2013-06-04 23:36:41 +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`.