llvm/docs
Sylvestre Ledru e9d67e46c2 fix various typos
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@306262 91177308-0d34-0410-b5e6-96231b3b80d8
2017-06-26 02:45:39 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide Resubmit r297897: [PGO] Value profile for size of memory intrinsic calls 2017-03-16 21:15:48 +00:00
Frontend
HistoricalNotes
PDB
Proposals fix various typos 2017-06-26 02:45:39 +00:00
TableGen Improvements to TableGen/LangIntro.rst 2017-05-02 13:47:10 +00:00
tutorial
AdvancedBuilds.rst
AliasAnalysis.rst Invariant.group and mustalias docs fixes 2017-04-12 07:59:35 +00:00
AMDGPUUsage.rst fix various typos 2017-06-26 02:45:39 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
Benchmarking.rst Add some tips on benchmarking. 2017-05-24 16:39:12 +00:00
BigEndianNEON.rst
BitCodeFormat.rst Bitcode: Add a string table to the bitcode format. 2017-04-17 17:51:36 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst [Doc] Document prof metadata in LangRef 2017-06-15 15:57:12 +00:00
Bugpoint.rst
CMake.rst Docs: Fix pluralization in CMake docs 2017-05-20 05:25:19 +00:00
CMakeLists.txt Revert "Revert "CMake: Move sphinx detection into AddSphinxTarget.cmake"" 2017-05-09 01:41:28 +00:00
CMakePrimer.rst
CodeGenerator.rst Add documentation for various aspects of the AMDGPU backend. 2017-06-06 20:31:59 +00:00
CodeOfConduct.rst
CodingStandards.rst
CommandLine.rst
CompileCudaWithLLVM.rst
CompilerWriterInfo.rst Add documentation for various aspects of the AMDGPU backend. 2017-06-06 20:31:59 +00:00
conf.py
Coroutines.rst [coroutines] Add syntax coloring to examples in Coroutines.rst 2017-04-05 05:26:26 +00:00
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen-mainpage.dox
doxygen.cfg.in Sync with changes from r300825 in clang. 2017-04-27 17:23:53 +00:00
Dummy.html
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Change section flag character for SHF_LINK_ORDER to "o". 2017-04-04 22:35:08 +00:00
FAQ.rst
FaultMaps.rst
GarbageCollection.rst
gcc-loops.png
GetElementPtr.rst [Doc] Fix getelementptr description about arguments 2017-06-19 05:34:21 +00:00
GettingStarted.rst Fix git command line in the Getting Started guide. 2017-05-15 22:32:34 +00:00
GettingStartedVS.rst Update the documentation and CMake file for Visual Studio generators. 2017-05-25 21:01:30 +00:00
GlobalISel.rst
GoldPlugin.rst [docs] As of binutils 2.21.51.0.2, ld.bfd supports plugins too, represent this in docs 2017-06-23 13:54:10 +00:00
HowToAddABuilder.rst Cosmetic change. 2017-04-24 21:06:29 +00:00
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst Fix RST docs AttributeList heading underline 2017-03-21 17:05:00 +00:00
HowToUseInstrMappings.rst
InAlloca.rst
index.rst Add documentation for various aspects of the AMDGPU backend. 2017-06-06 20:31:59 +00:00
LangRef.rst Define behavior of "stack-probe-size" attribute when inlining. 2017-06-22 23:22:36 +00:00
Lexicon.rst [Lexicon] Add GVN 2017-06-13 03:06:16 +00:00
LibFuzzer.rst [libFuzzer] update docs on -print_coverage/-dump_coverage 2017-05-09 01:34:27 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst Fix LLVMBuild.txt typo. NFC 2017-04-03 18:21:50 +00:00
LLVMBuild.txt
make.bat
Makefile.sphinx
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
MemorySSA.rst
MergeFunctions.rst
MIRLangRef.rst MIParser/MIRPrinter: Compute block successors if not explicitely specified 2017-05-05 21:09:30 +00:00
NVPTXUsage.rst
OptBisect.rst Remove opt-bisect support for "cases" in favor of debug counters 2017-03-11 01:41:03 +00:00
Packaging.rst
Passes.rst
Phabricator.rst docs/Phabricator: Better git examples to produce full context patches 2017-06-15 22:09:30 +00:00
ProgrammersManual.rst [docs] Simplify some language for Error/cantFail in the programmer's manual. 2017-04-30 17:24:52 +00:00
Projects.rst
re_format.7
README.txt Remove test commit change. 2017-06-24 20:13:32 +00:00
ReleaseNotes.rst Rename llvm-pdbdump -> llvm-pdbutil. 2017-06-09 20:46:17 +00:00
ReleaseProcess.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst
SegmentedStacks.rst
SourceLevelDebugging.rst PR32382: Fix emitting complex DWARF expressions. 2017-04-18 01:21:53 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [StackMaps] Increase the size of the "location size" field 2017-04-28 04:48:42 +00:00
Statepoints.rst Statepoint Docs: fix incorrect uses of it's 2017-04-19 23:55:03 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst
TestSuiteMakefileGuide.rst
TypeMetadata.rst
Vectorizers.rst [docs] Update name of vectorization interleave flag. 2017-05-31 23:02:55 +00:00
WritingAnLLVMBackend.rst
WritingAnLLVMPass.rst
XRay.rst fix various typos 2017-06-26 02:45:39 +00:00
XRayExample.rst [XRay][docs] Fix hyperlink to XRay doc 2017-04-06 04:26:26 +00:00
yaml2obj.rst
YamlIO.rst

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

Doxygen page Output
==============

Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.

    cd <build-dir>
    cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
    make doxygen-llvm # for LLVM docs
    make doxygen-clang # for clang docs

It will generate html in
    
    <build-dir>/docs/doxygen/html # for LLVM docs
    <build-dir>/tools/clang/docs/doxygen/html # for clang docs