llvm-project/llvm/docs
Tanya Lattner 0d28f80bd1 Rename all references to old mailing lists to new lists.llvm.org address.
llvm-svn: 243999
2015-08-05 03:51:17 +00:00
..
CommandGuide Improving lli documentation 2015-07-28 10:24:11 +00:00
Frontend Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +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
_ocamldoc [OCaml] Use a nicer style for documentation than OCaml default. 2015-07-17 06:37:59 +00:00
_static
_templates
_themes/llvm-theme
tutorial Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
AMDGPUUsage.rst AMDGPU/SI: Update amd_kernel_code_t definition and add assembler support 2015-06-26 21:58:31 +00:00
ARM-BE-bitcastfail.png [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. 2014-05-12 15:13:39 +00:00
ARM-BE-bitcastsuccess.png [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. 2014-05-12 15:13:39 +00:00
ARM-BE-ld1.png [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. 2014-05-12 15:13:39 +00:00
ARM-BE-ldr.png [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. 2014-05-12 15:13:39 +00:00
AliasAnalysis.rst [PM/AA] Hoist the AliasResult enum out of the AliasAnalysis class. 2015-06-22 02:16:51 +00:00
Atomics.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
BigEndianNEON.rst Fix typos 2014-05-15 01:52:21 +00:00
BitCodeFormat.rst Move the personality function from LandingPadInst to Function 2015-06-17 20:52:32 +00:00
BitSets.rst LowerBitSets: Introduce global layout builder. 2015-02-24 23:17:02 +00:00
BlockFrequencyTerminology.rst Fix typos 2014-05-15 01:52:21 +00:00
BranchWeightMetadata.rst Add function entry count metadata. 2015-05-13 15:13:45 +00:00
Bugpoint.rst Correct 'teh' and other typos / repeated words. 2015-04-14 20:52:58 +00:00
BuildingLLVMWithAutotools.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
CMake.rst docs: Update allowed values for LLVM_USE_SANITIZER 2015-06-22 18:55:46 +00:00
CMakeLists.txt [OCaml] Use a nicer style for documentation than OCaml default. 2015-07-17 06:37:59 +00:00
CodeGenerator.rst [NFC] Minor editorial fixes to the CodeGen docs. 2015-07-02 09:32:01 +00:00
CodingStandards.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
CommandLine.rst Add missing underlines for a docs section. NFC 2015-07-24 00:29:50 +00:00
CompilerWriterInfo.rst R600 -> AMDGPU rename 2015-06-13 03:28:10 +00:00
CoverageMappingFormat.rst Fix Sphinx error about duplicate label in CommandLine.rst:1560 and CoverageMappingFormat.rst 2015-07-14 23:29:53 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
Dummy.html
ExceptionHandling.rst Rename llvm.frameescape and llvm.framerecover to localescape and localrecover 2015-07-07 22:25:32 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
Extensions.rst Use a comma after the unique keyword. 2015-04-06 16:34:41 +00:00
FAQ.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
FaultMaps.rst [FaultMaps] Let the frontend pre-select implicit null check candidates. 2015-06-30 21:22:32 +00:00
GarbageCollection.rst Document the CoreCLR GC Strategy 2015-05-21 00:50:10 +00:00
GetElementPtr.rst Update LangRef for getelementptr explicit type changes 2015-03-04 22:02:58 +00:00
GettingStarted.rst [GettingStarted.rst] Commit the right patch. 2015-08-04 03:12:33 +00:00
GettingStartedVS.rst Update the docs to require at least MSVC 2013. 2015-02-15 19:34:17 +00:00
GoldPlugin.rst Docs: give binutils/gold instructions for CMake too. 2014-11-04 02:16:03 +00:00
HowToAddABuilder.rst
HowToBuildOnARM.rst Clean up docs references to './configure' in preparation for deprecating in-source builds 2015-04-29 20:06:41 +00:00
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst docs: Add information about helper scripts to HowToReleaseLLVM page 2015-07-31 01:02:35 +00:00
HowToSetUpLLVMStyleRTTI.rst [docs][LLVM-style RTTI] Add a mention of multiple inheritance. 2015-02-07 01:16:26 +00:00
HowToSubmitABug.rst Delete -std-compile-opts. 2014-10-16 20:00:02 +00:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst inalloca: *Really* fix the docs 2014-03-27 01:38:48 +00:00
LLVMBuild.rst [docs] Fix some links 2014-04-07 22:46:40 +00:00
LLVMBuild.txt
LangRef.rst DI: Remove DW_TAG_arg_variable and DW_TAG_auto_variable 2015-07-31 18:58:39 +00:00
Lexicon.rst [docs] Document "LGTM" in the lexicon. 2015-06-04 20:28:09 +00:00
LibFuzzer.rst [libFuzzer] minimal documentation on data-flow-guided fuzzing 2015-07-31 21:48:10 +00:00
LinkTimeOptimization.rst Fix a typo in the documentation of LTO 2014-12-03 07:32:36 +00:00
MCJIT-creation.png
MCJIT-dyld-load.png
MCJIT-engine-builder.png
MCJIT-load-object.png
MCJIT-load.png
MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst Minor typo. 2014-09-05 04:56:43 +00:00
Makefile [docs] Update the doxygen configuration file. 2015-03-12 17:26:27 +00:00
Makefile.sphinx Revert "Treat warnings in Sphinx as errors. The reasons for doing this are..." 2014-07-22 18:09:17 +00:00
MakefileGuide.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
MarkedUpDisassembly.rst undo test commit (whitespace only) 2014-06-30 08:09:35 +00:00
MergeFunctions.rst Inspired by r231891, use gender neutral pronouns in the places I've 2015-03-11 00:15:44 +00:00
NVPTXUsage.rst [docs] fix the declarations of the llvm.nvvm.ptr.gen.to.* intrinsics 2015-05-29 22:18:03 +00:00
Packaging.rst
Passes.rst Remove the preverify pass from the documentation now that it has been removed 2015-01-30 20:51:09 +00:00
Phabricator.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
ProgrammersManual.rst Reverting r243386 because it has serious post-commit concerns that have not been addressed. Also reverts r243389, which relied on this commit. 2015-07-29 15:57:49 +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
README.txt [docs] Add a note to docs/README.txt 2014-04-22 21:47:53 +00:00
ReleaseNotes.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
ReleaseProcess.rst
SegmentedStacks.rst Move the segmented stack switch to a function attribute 2014-04-10 22:58:43 +00:00
SourceLevelDebugging.rst DI: Remove DW_TAG_arg_variable and DW_TAG_auto_variable 2015-07-31 18:58:39 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst List supported architectures for StackMap section and related intrinsics 2015-07-16 21:10:46 +00:00
Statepoints.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
SystemLibrary.rst
TableGenFundamentals.rst Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
TestSuiteMakefileGuide.rst
TestingGuide.rst Document some of the options in test/lit.cfg 2015-05-04 21:37:00 +00:00
Vectorizers.rst Correct 'teh' and other typos / repeated words. 2015-04-14 20:52:58 +00:00
WritingAnLLVMBackend.rst configure.ac lives in autoconf/, not autotools/ 2014-11-10 22:36:04 +00:00
WritingAnLLVMPass.rst [PM] Split the LoopInfo object apart from the legacy pass, creating 2015-01-17 14:16:18 +00:00
YamlIO.rst [YAMLIO] Make line-wrapping configurable and test it. 2015-05-29 17:56:28 +00:00
conf.py Update the trunk version to 3.8.0svn. 2015-07-14 22:35:57 +00:00
doxygen.cfg.in Doxygen: Enable autobrief feature and update coding standards. 2015-05-15 03:34:01 +00:00
doxygen.intro
gcc-loops.png
index.rst Rename all references to old mailing lists to new lists.llvm.org address. 2015-08-05 03:51:17 +00:00
linpack-pc.png
make.bat
re_format.7
yaml2obj.rst Summary: 2015-07-28 16:18:17 +00:00

README.txt

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`.

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

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

    cd docs/
    make -f Makefile.sphinx linkcheck