llvm/docs
Wilfred Hughes 5949d69774 Fix typo.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@262802 91177308-0d34-0410-b5e6-96231b3b80d8
2016-03-06 12:37:34 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide Add -match-full-lines argument to FileCheck. 2016-02-11 16:46:09 +00:00
Frontend [docs][PerformanceTips] Add text on allocas and alignment 2015-09-10 17:03:10 +00:00
HistoricalNotes
TableGen Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
tutorial Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
AliasAnalysis.rst fix typo 2016-01-13 16:46:41 +00:00
AMDGPUUsage.rst fix the indentation of the example 2016-02-23 11:17:27 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst [CodeGen] Refactor TLI/AtomicExpand interface to make LLSC explicit. 2015-09-11 17:08:28 +00:00
BigEndianNEON.rst
BitCodeFormat.rst Rename embedded bitcode section in MachO 2016-02-29 19:40:10 +00:00
BitSets.rst docs: Document how bitsets may be used to encode type information. 2016-02-03 02:01:08 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst Fix typos. 2015-09-12 01:17:08 +00:00
Bugpoint.rst
CMake.rst cmake: Accept "thin" or "full" as arguments to -DLLVM_ENABLE_LTO 2016-02-08 21:01:24 +00:00
CMakeLists.txt Doxygen: add build option to use svg instead of png files for graphs 2015-08-17 23:24:17 +00:00
CodeGenerator.rst Fixing a typo in docs/CodeGenerator.rst 2015-11-13 15:14:04 +00:00
CodingStandards.rst Disable Visual C++ 2013 Debug mode assert on null pointer in some STL algorithms, 2015-08-21 17:31:03 +00:00
CommandLine.rst
CompileCudaWithLLVM.rst [doc] Obtaining help on LLVM's CUDA support. 2016-02-23 23:34:49 +00:00
CompilerWriterInfo.rst ARM: improve documentation slightly. 2016-02-09 23:55:48 +00:00
conf.py Update version to 3.9. 2016-01-13 17:32:32 +00:00
CoverageMappingFormat.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Fix a spurious if. 2015-12-11 00:51:59 +00:00
doxygen-mainpage.dox [docs] Updated docs to work with Doxygen 1.8.11 2016-03-06 03:50:08 +00:00
doxygen.cfg.in [docs] Updated docs to work with Doxygen 1.8.11 2016-03-06 03:50:08 +00:00
Dummy.html
ExceptionHandling.rst [WinEH] Disallow cyclic unwinds 2016-01-10 04:31:05 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst [WinEH] Add llvm.eh.exceptionpointer intrinsic 2015-09-03 09:15:32 +00:00
Extensions.rst
FAQ.rst
FaultMaps.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst [docs] Remove now confusing references to cofigure/autoconf 2016-02-07 16:35:04 +00:00
GettingStartedVS.rst [docs] Add a note that the Visual Studio C++ tools are required 2016-02-07 19:36:54 +00:00
GoldPlugin.rst [docs] Remove references to autotools build. 2016-01-30 01:10:15 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst [Docs] Change ARM build info to CMake 2015-11-06 18:39:34 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst [docs] Remove references to autotools build. 2016-01-30 01:10:15 +00:00
LangRef.rst Minor doc fix: statepoints are invokable too 2016-02-26 03:33:59 +00:00
Lexicon.rst
LibFuzzer.rst [libFuzzer] more trophies 2016-03-02 19:45:10 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fixing the documentation builds 2016-01-26 22:53:12 +00:00
LLVMBuild.txt
make.bat
MarkedUpDisassembly.rst
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst Fix several accidental DOS line endings in source files 2016-01-03 17:22:03 +00:00
MergeFunctions.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
MIRLangRef.rst MIRLangRef: Add documentation for the subregister indices. 2015-09-08 11:39:47 +00:00
NVPTXUsage.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
Packaging.rst
Passes.rst
Phabricator.rst [docs] Improve the documentation on committing code reviewed on 2016-01-14 13:39:29 +00:00
ProgrammersManual.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
Projects.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
re_format.7
README.txt [docs] Update the docs to describe how to build the docs with cmake 2016-02-07 15:42:12 +00:00
ReleaseNotes.rst Mention 'notail' attribute in 3.9 release notes. 2016-02-17 19:35:47 +00:00
ReleaseProcess.rst [OPENMP] Make -fopenmp to turn on OpenMP support by default. 2015-12-10 05:45:58 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Fix minor error with debug info doc. 2016-02-12 06:19:16 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst [Statepoint docs] Delete trailing whitespace 2016-03-04 18:14:09 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst Fixing the documentation builds 2016-01-26 22:53:12 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst Fix typo. 2016-03-06 12:37:34 +00:00
yaml2obj.rst Summary: 2015-07-28 16:18:17 +00:00
YamlIO.rst [docs] Fix typo in YamlIO.rst 2016-02-04 20:42:43 +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 <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
    make -j3 docs-llvm-html
    $BROWSER <build-dir>/docs//html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//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-dir>/docs/man/`.

    cd <build-dir>
    cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
    make -j3 docs-llvm-man
    man -l >build-dir>/docs/man/FileCheck.1

The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//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`.

Checking links
==============

The reachability of external links in the documentation can be checked by
running:

    cd docs/
    make -f Makefile.sphinx linkcheck