llvm-mirror/docs
Kostya Serebryany f69f881341 [libFuzzer] Improve documentation
Reviewers: kcc

Subscribers: llvm-commits

Differential Revision: http://reviews.llvm.org/D19585

llvm-svn: 267892
2016-04-28 15:19:05 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide Document standard substitutions defined by lit. 2016-04-04 17:14:45 +00:00
Frontend
HistoricalNotes
TableGen
tutorial Remove every uses of getGlobalContext() in LLVM (but the C API) 2016-04-14 21:59:01 +00:00
AdvancedBuilds.rst Fixing autocorrect changing cmake->make 2016-03-18 22:11:51 +00:00
AliasAnalysis.rst
AMDGPUUsage.rst AMDGPU: Document address space mapping 2016-04-06 01:29:19 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst Add __atomic_* lowering to AtomicExpandPass. 2016-04-12 20:18:48 +00:00
BigEndianNEON.rst
BitCodeFormat.rst Swift Calling Convention: add swiftcc. 2016-04-05 22:41:47 +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
Bugpoint.rst
CMake.rst [Docs] Updating CMake docs to include LLVM_OPTIMIZED_TABLEGEN 2016-03-24 18:46:43 +00:00
CMakeLists.txt
CodeGenerator.rst [docs] "Straightforward" is one word. 2016-03-14 20:18:51 +00:00
CodingStandards.rst
CommandLine.rst
CompileCudaWithLLVM.rst [docs] Add gpucc publication and tutorial. 2016-03-30 05:05:40 +00:00
CompilerWriterInfo.rst Update psabi link for x86-64. Add link to linux gabi supplement. 2016-04-12 21:54:57 +00:00
conf.py
CoverageMappingFormat.rst [docs] Corrections w.r.t V2 of the coverage mapping format 2016-03-28 22:16:01 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Point link to CODE_OWNERS.txt to klaus instead of viewvc. 2016-04-22 17:41:12 +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
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst FAQ: Remove the entire Build Problems section 2016-03-23 06:54:42 +00:00
FaultMaps.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst docs: Fix footnote after r260042. 2016-03-28 21:24:46 +00:00
GettingStartedVS.rst Clarifying some of the requirements for building with Visual Studio on Windows. Namely, we require the latest Update to be installed (for sanity purposes), and we require CMake 2.8.12.2 for building LLVM with Visual Studio. 2016-03-29 20:23:55 +00:00
GoldPlugin.rst [docs] Remove references to autotools build. 2016-01-30 01:10:15 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst
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 Updates based on post-commit review of r263834 2016-03-18 21:57:51 +00:00
LangRef.rst Fixed sphinx warning from r267672 2016-04-27 05:59:51 +00:00
Lexicon.rst
LibFuzzer.rst [libFuzzer] Improve documentation 2016-04-28 15:19:05 +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
Makefile.sphinx Bring back Makefile.sphinx 2016-03-23 00:30:57 +00:00
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
MergeFunctions.rst Fix some typos in the llvm doc 2016-02-14 20:16:22 +00:00
MIRLangRef.rst
NVPTXUsage.rst [NVPTX] Make NVVMReflect a function pass. 2016-03-30 20:40:11 +00:00
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst Remove every uses of getGlobalContext() in LLVM (but the C API) 2016-04-14 21:59:01 +00:00
Projects.rst
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 [ppc64] Reenable sibling call optimization on ppc64 since fixed tsan library tail-call issue 2016-04-26 07:38:24 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst testcase gardening: update the emissionKind enum to the new syntax. (NFC) 2016-04-01 00:16:49 +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 Fix the docs I broke 2016-03-11 23:31:02 +00:00
Vectorizers.rst
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst Fix typo. 2016-03-06 12:37:34 +00:00
yaml2obj.rst
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