llvm/docs
Sanjoy Das 65bdf0ae4a Fix a misleading phrase in the LangRef
Reviewers: hfinkel, dberlin

Subscribers: mcrosier, llvm-commits

Differential Revision: https://reviews.llvm.org/D37432

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@313170 91177308-0d34-0410-b5e6-96231b3b80d8
2017-09-13 18:49:22 +00:00
..
_ocamldoc
_static
_templates
_themes/llvm-theme
CommandGuide [llvm-cov] Read in function names for filtering from a text file. 2017-08-31 09:11:31 +00:00
Frontend
HistoricalNotes
PDB Add documentation for the PDB Module Info stream. 2016-11-29 22:14:56 +00:00
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 [ORC][Kaleidoscope] Update Chapter 1 of BuildingAJIT to incorporate recent ORC 2017-08-15 19:20:10 +00:00
AdvancedBuilds.rst
AliasAnalysis.rst [docs] AliasAnalysis: clarify that PartialAlias doesn't enforce 2017-07-15 09:09:24 +00:00
AMDGPUUsage.rst Update AMDGPUUsage.rst documentation: 2017-08-15 20:47:41 +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 [cmake] Stop putting the revision info in LLVM_VERSION_STRING 2017-08-29 21:44:21 +00:00
CMakeLists.txt Revert "Revert "CMake: Move sphinx detection into AddSphinxTarget.cmake"" 2017-05-09 01:41:28 +00:00
CMakePrimer.rst [docs] In the CMake primer, correct the description of the ARGV/ARGN variables. 2017-08-24 05:38:39 +00:00
CodeGenerator.rst Add documentation for various aspects of the AMDGPU backend. 2017-06-06 20:31:59 +00:00
CodeOfConduct.rst
CodingStandards.rst [docs] Add a note on iteration of unordered containers to coding standards 2017-09-06 20:19:10 +00:00
CommandLine.rst Update CommandLine.rst getRegisteredOptions example 2016-11-07 02:43:01 +00:00
CompileCudaWithLLVM.rst [Docs] Update docs to indicate that CUDA compilation is supported on Windows. 2017-01-05 16:54:28 +00:00
CompilerWriterInfo.rst Fix broken links to the Itanium CXX ABI 2017-09-12 00:19:11 +00:00
conf.py Update trunk version to 6.0.0svn 2017-07-19 12:19:01 +00:00
Coroutines.rst fix trivial typos in documents; NFC 2017-07-02 12:44:27 +00:00
CoverageMappingFormat.rst fix some typos in the doc 2017-01-14 11:37:01 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
Docker.rst Made a script to build docker images easier to use. 2017-07-06 12:46:51 +00:00
doxygen-mainpage.dox
doxygen.cfg.in Sync with changes from r300825 in clang. 2017-04-27 17:23:53 +00:00
ExceptionHandling.rst Fix broken links to the Itanium CXX ABI 2017-09-12 00:19:11 +00:00
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 Fix the docs build 2017-02-07 20:36:03 +00:00
GarbageCollection.rst Tidy up example of getting the pointer size. 2016-10-14 05:45:46 +00:00
gcc-loops.png
GetElementPtr.rst [docs] change a few code-blocks to llvm from text 2017-07-26 14:11:23 +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 Reapply "[GlobalISel] Remove the GISelAccessor API." 2017-08-15 22:31:51 +00:00
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 Added more info on silent master to the doc. 2017-07-05 20:45:44 +00:00
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst Update Bugzilla URLs in docs 2017-02-17 08:26:11 +00:00
HowToUseAttributes.rst Fix RST docs AttributeList heading underline 2017-03-21 17:05:00 +00:00
HowToUseInstrMappings.rst
InAlloca.rst
index.rst docs: remove dead doxygen tarball link 2017-08-30 17:40:28 +00:00
LangRef.rst Fix a misleading phrase in the LangRef 2017-09-13 18:49:22 +00:00
Lexicon.rst [Lexicon] Add "GEP" 2017-08-18 15:35:53 +00:00
LibFuzzer.rst [libFuzzer] recommend Clang Coverage for coverage visualization 2017-08-11 20:32:47 +00:00
LinkTimeOptimization.rst [docs] Typos and whitespace fixed in LTO docs. 2016-11-29 18:00:31 +00:00
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 Update NVVMReflect usage doc to new idiom for adding target-specific early passes. 2017-01-27 19:44:24 +00:00
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 Refine report_fatal_error guidance after post-commit review 2017-08-18 06:45:34 +00:00
Projects.rst
re_format.7
README.txt Remove test commit change. 2017-06-24 20:13:32 +00:00
ReleaseNotes.rst Clear release notes for 6.0.0 2017-07-19 14:09:16 +00:00
ReleaseProcess.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst [docs] Fix Scudo documentation error 2017-08-29 19:54:19 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Remove the obsolete offset parameter from @llvm.dbg.value 2017-07-28 20:21:02 +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 [docs] change a few code-blocks to llvm from text 2017-07-26 14:11:23 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst [docs] cleanup documentation on lit substitutions 2017-02-09 14:12:30 +00:00
TestSuiteMakefileGuide.rst
TypeMetadata.rst Fix broken links to the Itanium CXX ABI 2017-09-12 00:19:11 +00:00
Vectorizers.rst [docs] Update name of vectorization interleave flag. 2017-05-31 23:02:55 +00:00
WritingAnLLVMBackend.rst [docs] Document how to debug instruction scheduling model generation 2017-07-19 14:10:42 +00:00
WritingAnLLVMPass.rst [docs] Make WritingAnLLVMPass.rst up-to-date with current state of things 2016-09-27 12:07:21 +00:00
XRay.rst Xray docs with description of Flight Data Recorder binary format. 2017-08-02 21:47:27 +00:00
XRayExample.rst Fix some minor typos in the llvm XRay exemple 2017-08-12 15:08:11 +00:00
XRayFDRFormat.rst Fix some minor typos in the llvm XRay exemple 2017-08-12 15:08:11 +00:00
yaml2obj.rst
YamlIO.rst fix some typos in the doc 2017-01-14 11:37:01 +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

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