llvm-6502/docs
Daniel Sanders d7d96ee191 [docs] Mention character array constants in docs/LangRef.rst
Summary:
They were used in the 'Module Structure' example but weren't otherwise
documented.

Credit to Reed Kotler for noticing.

Reviewers: hans

Reviewed By: hans

Subscribers: hans, llvm-commits

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@217583 91177308-0d34-0410-b5e6-96231b3b80d8
2014-09-11 12:02:59 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide [LIT] Remove documentation for method since it does not exist 2014-08-21 18:52:58 +00:00
HistoricalNotes
TableGen Document !and. Fix !shl and friends -- they provide binary operations. 2014-09-03 13:17:03 +00:00
tutorial [docs] Clean up some more llvm-gcc stuff 2014-02-19 00:12:34 +00:00
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 Update links to the gcc and java documentation that 404'd. 2014-08-04 09:26:40 +00:00
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 Introduce -DLLVM_USE_SANITIZER=Undefined CMake option to build UBSan-ified version of LLVM/Clang. 2014-08-29 00:50:36 +00:00
CMakeLists.txt Added Sphinx documentation generation to CMake build system. 2014-04-18 21:45:25 +00:00
CodeGenerator.rst [sphinx cleanup] 2014-09-10 20:43:03 +00:00
CodingStandards.rst CodingStandards: Document std::equal misbehaviour 2014-08-19 16:49:40 +00:00
CommandLine.rst
CompilerWriterInfo.rst Fix some doc and comment typos 2014-04-09 14:47:27 +00:00
conf.py Update LLVM version: 3.5 => 3.6 2014-07-28 22:10:52 +00:00
CoverageMappingFormat.rst Docs: add documentation for the coverage mapping format. 2014-08-19 17:05:58 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst Document what backwards compatibility we provide for bitcode. 2014-07-23 22:43:22 +00:00
doxygen.cfg.in [docs] Teach CMake docs build how to generate Qt Creator help/documentation files. 2014-03-07 19:19:28 +00:00
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 ARM: add VLA extension for WoA Itanium ABI 2014-06-09 20:18:42 +00:00
FAQ.rst remove an old entry whose link is broken anyway 2014-03-02 06:37:03 +00:00
GarbageCollection.rst Remove the TargetMachine forwards for TargetSubtargetInfo based 2014-08-04 21:25:23 +00:00
gcc-loops.png
GetElementPtr.rst [docs] Clean up some more llvm-gcc stuff 2014-02-19 00:12:34 +00:00
GettingStarted.rst Delete support for AuroraUX. 2014-08-14 15:15:09 +00:00
GettingStartedVS.rst Document how to select build configuration with Visual C++ IDE or command line. 2014-06-05 16:42:26 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst docs: Update relaease documents to include the patch number in the RELEASE tags 2014-07-21 14:28:31 +00:00
HowToSetUpLLVMStyleRTTI.rst [C++11] Replace LLVM-style type traits with C++11 standard ones. 2014-03-07 14:42:25 +00:00
HowToSubmitABug.rst [docs] Nuke some references to llvm-gcc 2014-02-18 23:56:43 +00:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst inalloca: *Really* fix the docs 2014-03-27 01:38:48 +00:00
index.rst Docs: add documentation for the coverage mapping format. 2014-08-19 17:05:58 +00:00
LangRef.rst [docs] Mention character array constants in docs/LangRef.rst 2014-09-11 12:02:59 +00:00
Lexicon.rst [docs] Document what "NFC" means in a commit message. 2014-09-06 00:19:16 +00:00
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 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
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
NVPTXUsage.rst
Packaging.rst
Passes.rst docs: Remove documentation for legacy PGO options 2014-06-04 06:29:38 +00:00
Phabricator.rst Phabricator doc: Explicit the fact that the patch needs to be there before the commit 2014-07-04 09:00:35 +00:00
ProgrammersManual.rst Fix typos in comments, NFC 2014-08-29 21:53:01 +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 Fix link to 3.5 release notes. 2014-09-04 15:26:10 +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 Use DILexicalBlockFile, rather than DILexicalBlock, to track discriminator changes to ensure discriminator changes don't introduce new DWARF DW_TAG_lexical_blocks. 2014-08-21 22:45:21 +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 Reduce verbiage of lit.local.cfg files 2014-06-09 22:42:55 +00:00
TestSuiteMakefileGuide.rst
Vectorizers.rst Vectorization documentation for loop hint pragmas and Rpass diagnostics. 2014-06-27 18:30:08 +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