llvm-6502/docs
Dmitri Gribenko c8c3dbd911 Documentation for FileCheck: use 'option' and 'program' directives.
This enables option cross-referencing and now '--' in option names are no more turned into en dashes.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168926 91177308-0d34-0410-b5e6-96231b3b80d8
2012-11-29 19:21:02 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide Documentation for FileCheck: use 'option' and 'program' directives. 2012-11-29 19:21:02 +00:00
HistoricalNotes
tutorial
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst Better 80cols... *sigh* 2012-11-20 18:14:15 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst
CodeGenerator.rst Documentation: formatting improvements 2012-11-29 16:12:13 +00:00
CodingStandards.rst docs: CodingStandards should follow the coding standards. 2012-11-17 23:25:33 +00:00
CommandLine.rst
CompilerWriterInfo.rst Update link to external document 2012-11-12 23:43:34 +00:00
conf.py Bump sphinx config to 3.3. 2012-11-17 22:12:59 +00:00
DebuggingJITedCode.rst
design_and_overview.rst
DeveloperPolicy.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
development_process.rst docs: Sphinxify LLVMBuild documentation. 2012-11-20 03:13:53 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
FAQ.rst
GarbageCollection.html
GetElementPtr.rst
GettingStarted.rst docs: [CMake] Add Xcode to the list of project formats CMake can generate. 2012-11-27 23:34:28 +00:00
GettingStartedVS.rst
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst Minor enhancement to build process notes for ARM platforms. 2012-10-26 12:09:47 +00:00
HowToReleaseLLVM.html
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseInstrMappings.rst Fix typo. 2012-11-15 21:21:01 +00:00
index.rst
LangRef.html Fast-math flags documentation added to LangRef 2012-11-27 00:48:29 +00:00
Lexicon.rst
LinkTimeOptimization.rst
LLVMBuild.rst docs: Sphinxify LLVMBuild documentation. 2012-11-20 03:13:53 +00:00
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
MarkedUpDisassembly.rst
Packaging.rst
Passes.html Remove 'sretpromotion' pass from the documentation. This pass is long 2012-11-22 11:17:08 +00:00
Phabricator.rst docs: use code font for console commands in phabricator manual 2012-11-06 15:04:37 +00:00
ProgrammersManual.html
programming.rst
Projects.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
re_format.7
README.txt
ReleaseNotes.html Note Freescale's contributions in the PPC release notes. 2012-11-20 04:20:31 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst Some grammar fixes 2012-11-28 00:27:25 +00:00
SphinxQuickstartTemplate.rst
subsystems.rst Documentation: convert SourceLevelDebugging.html to reST 2012-11-22 11:56:02 +00:00
SystemLibrary.rst Documentation: improve formatting and remove unneeded empty lines. 2012-11-28 21:40:54 +00:00
TableGenFundamentals.rst Some sphinx-ing and consistency fixes 2012-11-20 19:37:58 +00:00
TestingGuide.rst Documentation: remove a copy of the FileCheck man page from TestingGuide 2012-11-18 18:28:14 +00:00
TestSuiteMakefileGuide.rst docs: Sphinxify TestSuiteMakefileGuide 2012-11-14 23:11:10 +00:00
userguides.rst docs: Sphinxify TestingGuide 2012-11-14 21:09:30 +00:00
WritingAnLLVMBackend.html add TableGen support to create relationship maps between instructions 2012-10-25 15:54:06 +00:00
WritingAnLLVMPass.html
yaml2obj.rst

LLVM Documentation
==================

The LLVM documentation is currently written in two formats:

  * Plain HTML documentation.

  * reStructured Text documentation using the Sphinx documentation generator. It
    is currently tested with Sphinx 1.1.3. 

    For more information, see the "Sphinx Introduction for LLVM Developers"
    document.