llvm-project

History

Bill Wendling fab09c66f3 Sphinxify the CMake document. llvm-svn: 159806		2012-07-06 05:51:50 +00:00
..
CommandGuide	Fix the formatting a bit.	2012-06-20 11:25:11 +00:00
HistoricalNotes	Fix a ton of comment typos found by codespell. Patch by	2011-04-15 05:18:47 +00:00
_static	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
_templates	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +00:00
llvm-theme	[docs] Make it pretty.	2012-06-15 22:17:44 +00:00
tutorial	Move llvm/Support/IRBuilder.h -> llvm/IRBuilder.h	2012-06-29 12:38:19 +00:00
AliasAnalysis.rst	Sphinxify the AliasAnalysis document.	2012-06-20 09:49:57 +00:00
Atomics.rst	Sphinxify the Atomics documentation.	2012-06-29 09:00:01 +00:00
BitCodeFormat.rst	Sphinxify the bitcode format document.	2012-06-28 08:43:12 +00:00
BranchWeightMetadata.rst	Sphinxify BranchWeightMetadata document.	2012-06-20 10:17:46 +00:00
Bugpoint.rst	Sphyinxify the Bugpoint document.	2012-06-26 11:37:00 +00:00
CMake.rst	Sphinxify the CMake document.	2012-07-06 05:51:50 +00:00
CodeGenerator.html	Remove/modify C backend references from LLVM documentation.	2012-06-14 16:52:55 +00:00
CodingStandards.rst	Put space after "code-block::".	2012-06-20 23:57:00 +00:00
CommandLine.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
CompilerWriterInfo.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
DebuggingJITedCode.html	Fix Xcode case (Upper X, lower c)	2012-05-13 14:36:15 +00:00
DeveloperPolicy.rst	Sphinxify the developer policy document.	2012-06-20 11:20:07 +00:00
ExceptionHandling.rst	Sphinxify the exception handling doc.	2012-06-27 07:20:57 +00:00
ExtendedIntegerResults.txt	Revert r103213. It broke several sections of live website.	2010-05-07 00:28:04 +00:00
ExtendingLLVM.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
FAQ.rst	[docs] Port FAQ over to Sphinx.	2012-06-18 20:21:38 +00:00
GCCFEBuildInstrs.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
GarbageCollection.html	Use correct variable in this example. Pointed out by waynix on IRC.	2012-05-03 15:25:19 +00:00
GetElementPtr.rst	Sphixify the GEP FAQ.	2012-06-20 21:54:22 +00:00
GettingStarted.html	Add a new broken compiler.	2012-06-06 07:39:39 +00:00
GettingStartedVS.rst	[docs] Sphinxify GettingStartedVS. Patch by Mikael Lyngvig!	2012-06-21 23:27:09 +00:00
GoldPlugin.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
HowToAddABuilder.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
HowToReleaseLLVM.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
HowToSubmitABug.html	Remove/modify C backend references from LLVM documentation.	2012-06-14 16:52:55 +00:00
LLVMBuild.html	llvm-build: Add support for non-installed libraries (e.g., gtest).	2012-05-15 18:44:17 +00:00
LLVMBuild.txt	LLVMBuild: Remove trailing newline, which irked me.	2011-12-12 19:48:00 +00:00
LangRef.html	add @llvm.donothing	2012-07-05 17:37:07 +00:00
Lexicon.rst	Sphinxify the lexicon doc.	2012-06-20 10:36:41 +00:00
LinkTimeOptimization.rst	Sphinxify the LTO document.	2012-06-20 10:08:02 +00:00
Makefile	[docs] Remove POD based man page docs (and build system support).	2012-05-08 17:48:21 +00:00
Makefile.sphinx	[docs] Stub out structure for Sphinx-based docs.	2012-04-19 16:31:19 +00:00
MakefileGuide.rst	Sphinxify the MakefileGuide document.	2012-06-20 04:20:39 +00:00
Packaging.rst	Sphinxify the outdated Packaging documentation.	2012-06-21 06:09:37 +00:00
Passes.html	Fix typos found by http://github.com/lyda/misspell-check	2012-06-02 10:20:22 +00:00
ProgrammersManual.html	Reapply the SmallMap patch with a fix.	2012-04-25 18:01:58 +00:00
Projects.rst	Use correct capitalization.	2012-06-19 22:25:17 +00:00
README.txt	[docs] Stub out structure for Sphinx-based docs.	2012-04-19 16:31:19 +00:00
ReleaseNotes.html	Remove old release notes. Ready them for additions from current development	2012-05-24 06:38:09 +00:00
SegmentedStacks.rst	Sphinxify the SegmentedStack document.	2012-06-20 12:05:05 +00:00
SourceLevelDebugging.html	Fix typos found by http://github.com/lyda/misspell-check	2012-06-02 10:20:22 +00:00
SystemLibrary.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
TableGenFundamentals.rst	Cleanup some encoding mishaps.	2012-06-21 07:01:02 +00:00
TestSuiteMakefileGuide.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
TestingGuide.html	Revert r156393, "[tests] Remove some remaining DejaGNU related cruft.", this	2012-05-08 18:26:07 +00:00
WritingAnLLVMBackend.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
WritingAnLLVMPass.html	[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
conf.py	[docs] Add support for building man pages using Sphinx.	2012-05-08 16:50:47 +00:00
design_and_overview.rst	Sphixify the GEP FAQ.	2012-06-20 21:54:22 +00:00
development_process.rst	Move coding standards reference from development_process.rst to programming.rst.	2012-06-20 11:56:24 +00:00
doxygen.cfg.in	Reapply r141657.	2011-10-31 23:46:50 +00:00
doxygen.css	[docs] Update Makefile for images removal.	2012-04-20 17:27:12 +00:00
doxygen.footer	Happy new year 2012!	2012-01-01 08:16:56 +00:00
doxygen.header	Tidy up. s/Low Level Virtual Machine/LLVM/.	2012-01-25 22:00:23 +00:00
doxygen.intro	Tidy up. s/Low Level Virtual Machine/LLVM/.	2012-01-25 22:00:23 +00:00
index.rst	Fix typos found by http://github.com/lyda/misspell-check	2012-06-02 10:20:22 +00:00
mailing_lists.rst	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +00:00
make.bat	[docs] Stub out structure for Sphinx-based docs.	2012-04-19 16:31:19 +00:00
programming.rst	Move coding standards reference from development_process.rst to programming.rst.	2012-06-20 11:56:24 +00:00
re_format.7	Revert r103213. It broke several sections of live website.	2010-05-07 00:28:04 +00:00
subsystems.rst	Sphinxify the bitcode format document.	2012-06-28 08:43:12 +00:00
userguides.rst	Sphinxify the CMake document.	2012-07-06 05:51:50 +00:00

README.txt

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.