llvm-6502/docs
Justin Bogner e5d8481310 docs: Remove documentation for legacy PGO options
Late last year r191835 removed a largely unmaintained legacy PGO
infrastructure, but some of the docs were missed. Since these docs are
for things that don't actually exist anymore, they should be removed.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@210165 91177308-0d34-0410-b5e6-96231b3b80d8
2014-06-04 06:29:38 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide docs: Remove documentation for legacy PGO options 2014-06-04 06:29:38 +00:00
HistoricalNotes
TableGen [tablegen] Add !listconcat operator with the similar semantics as !strconcat 2014-05-07 10:13:19 +00:00
tutorial
AliasAnalysis.rst Update some AliasAnalysis pass docs for getAdjustedAnalysisPointer. 2014-05-22 19:38:25 +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
Atomics.rst
BigEndianNEON.rst Fix typos 2014-05-15 01:52:21 +00:00
BitCodeFormat.rst Revert "[ms-cxxabi] Add a new calling convention that swaps 'this' and 'sret'" 2014-05-09 22:56:42 +00:00
BlockFrequencyTerminology.rst Fix typos 2014-05-15 01:52:21 +00:00
BranchWeightMetadata.rst blockfreq: Document BlockFrequencyInfo terminology 2014-04-11 23:21:07 +00:00
Bugpoint.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
CMake.rst fixed a few typos 2014-05-28 20:07:37 +00:00
CMakeLists.txt Added Sphinx documentation generation to CMake build system. 2014-04-18 21:45:25 +00:00
CodeGenerator.rst Fix strange typo in markup. 2014-05-14 08:10:16 +00:00
CodingStandards.rst Update programmers manual to cover llvm::function_ref, and add a note to the 2014-05-06 07:45:39 +00:00
CommandLine.rst
CompilerWriterInfo.rst Fix some doc and comment typos 2014-04-09 14:47:27 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst Clean up language and grammar. 2014-05-20 17:11:11 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst Exception handling docs: Clarify how the llvm.eh.* intrinsics are used 2014-03-28 17:08:57 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Fix typos 2014-05-15 01:52:21 +00:00
FAQ.rst
GarbageCollection.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst fixed more typos 2014-05-30 21:18:13 +00:00
GettingStartedVS.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst inalloca: *Really* fix the docs 2014-03-27 01:38:48 +00:00
index.rst [ARM64-BE] Add sphinx documentation for the ARM64 NEON implementation. 2014-05-12 15:13:39 +00:00
LangRef.rst Allow alias to point to an arbitrary ConstantExpr. 2014-06-03 02:41:57 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst [docs] Fix some links 2014-04-07 22:46:40 +00:00
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst Remove projects/sample. 2014-03-12 22:40:22 +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
NVPTXUsage.rst
Packaging.rst
Passes.rst docs: Remove documentation for legacy PGO options 2014-06-04 06:29:38 +00:00
Phabricator.rst Update of the documentation: I think we are now happy with Phabricator 2014-05-14 09:22:15 +00:00
ProgrammersManual.rst GraphWriter: detect graph viewer programs at runtime 2014-06-02 01:40:04 +00:00
Projects.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
re_format.7
README.txt [docs] Add a note to docs/README.txt 2014-04-22 21:47:53 +00:00
ReleaseNotes.rst Be a bit more specific in the release notes. 2014-05-05 17:53:29 +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 Switch the type field in DIVariable and DIGlobalVariable over to DITypeRefs. 2014-03-18 02:34:58 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst Stack map docs. Remove some stray markup. 2014-04-03 07:08:21 +00:00
SystemLibrary.rst
TableGenFundamentals.rst Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
TestingGuide.rst
TestSuiteMakefileGuide.rst
Vectorizers.rst Fix whitespace in vectorizer example 2014-03-12 23:58:07 +00:00
WritingAnLLVMBackend.rst [docs] Fix some links 2014-04-07 22:46:40 +00:00
WritingAnLLVMPass.rst docs: Remove documentation for legacy PGO options 2014-06-04 06:29:38 +00:00
yaml2obj.rst Object: rename ARMV7 to ARMNT 2014-03-11 03:08:37 +00:00
YamlIO.rst [YAML] Add an optional argument EnumMask to the yaml::IO::bitSetCase(). 2014-05-23 08:07:09 +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 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