llvm-6502/docs
Sean Silva 87ed553019 docs: Sphinxify HowToSubmitABug
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164630 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-25 20:52:04 +00:00
..
_static
_templates
_themes/llvm-theme [Docs] Fix Sphinx incremental build. Patch by Sean Silva! 2012-09-05 19:44:47 +00:00
CommandGuide Remove references to compression in llvm-ar. It has been a long time since we 2012-08-10 01:57:52 +00:00
HistoricalNotes
tutorial
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst
CodeGenerator.rst Move header so that it can be picked up by other .rst files. 2012-08-08 06:42:30 +00:00
CodingStandards.rst Add missing 'to' and rephrase an explanation of GCC's assumptions. 2012-09-21 18:03:02 +00:00
CommandLine.rst Sphinxify the CommandLine document. 2012-08-08 08:21:24 +00:00
CompilerWriterInfo.html
conf.py [Docs] Fix Sphinx incremental build. Patch by Sean Silva! 2012-09-05 19:44:47 +00:00
DebuggingJITedCode.rst Fix Sphinx warnings. 2012-09-20 03:20:53 +00:00
design_and_overview.rst
DeveloperPolicy.rst Test commit 2012-09-18 22:21:43 +00:00
development_process.rst
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.html
FAQ.rst
GarbageCollection.html
GCCFEBuildInstrs.html
GetElementPtr.rst
GettingStarted.html
GettingStartedVS.rst
GoldPlugin.html
HowToAddABuilder.rst Patch by Sean Silva! 2012-09-13 23:51:08 +00:00
HowToReleaseLLVM.html
HowToSubmitABug.rst docs: Sphinxify HowToSubmitABug 2012-09-25 20:52:04 +00:00
index.rst
LangRef.html Say "bytes" instead of "address units", since that's what the 2012-09-21 18:41:30 +00:00
Lexicon.rst
LinkTimeOptimization.rst
LLVMBuild.html
LLVMBuild.txt
mailing_lists.rst
make.bat [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
Makefile
Makefile.sphinx [Docs] Fix Sphinx incremental build. Patch by Sean Silva! 2012-09-05 19:44:47 +00:00
MakefileGuide.rst
Packaging.rst
Passes.html
ProgrammersManual.html
programming.rst docs: Fix Sphinx warning over Atomics.rst. 2012-09-21 02:46:32 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.html Add a new optimization pass: Stack Coloring, that merges disjoint static allocations (allocas). Allocas are known to be 2012-09-06 09:17:37 +00:00
SegmentedStacks.rst
SourceLevelDebugging.html
subsystems.rst Fix Sphinx warnings. 2012-09-20 03:20:53 +00:00
SystemLibrary.html
TableGenFundamentals.rst
TestingGuide.html
TestSuiteMakefileGuide.html
userguides.rst docs: Sphinxify HowToSubmitABug 2012-09-25 20:52:04 +00:00
WritingAnLLVMBackend.html
WritingAnLLVMPass.html
yaml2obj.rst docs: Fix long-standing typo in yaml2obj.rst. 2012-09-21 19:48:16 +00:00

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.