llvm-project

History

John Criswell 4e711921ba Fixed grammar for the llvm.trap intrinsic description. llvm-svn: 156881		2012-05-16 00:26:51 +00:00
..
CommandGuide	Fix the tool documentation	2012-05-13 05:52:56 +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] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.	2012-04-19 20:20:34 +00:00
tutorial	[docs] Include the Kaleidescope tutorial in the Sphinx docs build.	2012-05-02 22:46:36 +00:00
AliasAnalysis.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
Atomics.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
BitCodeFormat.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
BranchWeightMetadata.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
Bugpoint.html	Fix broken internal link.	2012-04-20 18:20:24 +00:00
CMake.html	[CMake] Restructure how Clang, Polly and other external projects get included.	2012-04-26 19:43:35 +00:00
CodeGenerator.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
CodingStandards.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
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.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
ExceptionHandling.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
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.html	Correct spelling, q.v. http://en.wikipedia.org/wiki/Bourne_shell	2012-04-20 16:08:56 +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.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
GettingStarted.html	Fix Xcode case (Upper X, lower c)	2012-05-13 14:36:15 +00:00
GettingStartedVS.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
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	[docs] Remove spurious or unused images.	2012-04-20 15:06:20 +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	Fixed grammar for the llvm.trap intrinsic description.	2012-05-16 00:26:51 +00:00
Lexicon.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
LinkTimeOptimization.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
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.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
Packaging.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
Passes.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
ProgrammersManual.html	Reapply the SmallMap patch with a fix.	2012-04-25 18:01:58 +00:00
Projects.html	[docs] Remove unsupported references to ExtraSource variable.	2012-05-15 21:32:27 +00:00
README.txt	[docs] Stub out structure for Sphinx-based docs.	2012-04-19 16:31:19 +00:00
ReleaseNotes.html	Add blurb for Crack.	2012-05-15 20:47:23 +00:00
SegmentedStacks.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
SourceLevelDebugging.html	[docs] Remove spurious or unused images.	2012-04-20 15:06:20 +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.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
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	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +00:00
development_process.rst	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +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	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +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	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +00:00
re_format.7	Revert r103213. It broke several sections of live website.	2010-05-07 00:28:04 +00:00
subsystems.rst	[docs] Convert docs index page into Sphinx.	2012-04-19 16:31:37 +00:00
userguides.rst	[docs] Integrate the command guide into the toctree.	2012-05-08 16:50:43 +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.