1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 18:54:02 +01:00
llvm-mirror/docs
Daniel Dunbar 5a90abbbfc [docs] Stub out structure for Sphinx-based docs.
- Work in progress, this is just the basic structure.

llvm-svn: 155132
2012-04-19 16:31:19 +00:00
..
_templates [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
CommandGuide Some formatting and grammar fixes in the FileCheck documentation 2012-04-18 07:44:03 +00:00
HistoricalNotes Fix a ton of comment typos found by codespell. Patch by 2011-04-15 05:18:47 +00:00
img
llvm-theme [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
tutorial Install the PNG file as well. PR4780. 2011-10-16 08:24:30 +00:00
AliasAnalysis.html basic-aa does support AliasAnalysis chaining now. 2012-01-30 23:05:41 +00:00
Atomics.html s/SequeuentiallyConsistent/SequentiallyConsistent/g 2011-09-11 15:50:05 +00:00
BitCodeFormat.html docs: Introduce cascading style <div> and <p> continued on <h[2-5]>. 2011-04-23 00:30:22 +00:00
BranchWeightMetadata.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
Bugpoint.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
CMake.html Add profiling support for Intel Parallel Amplifier XE (VTune) for JITted code in LLVM. 2012-03-13 08:33:15 +00:00
CodeGenerator.html Fix class name. 2012-04-15 20:22:36 +00:00
CodingStandards.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
CommandLine.html docs: Introduce cascading style <div> and <p> continued on <h[2-5]>. 2011-04-23 00:30:22 +00:00
CompilerWriterInfo.html Remove the Alpha backend. 2011-10-27 22:56:32 +00:00
conf.py [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
contents.rst [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
DebuggingJITedCode.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
DeveloperPolicy.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
doxygen.cfg.in Reapply r141657. 2011-10-31 23:46:50 +00:00
doxygen.css docs/doxygen.css: Tweak padding on memdoc. 2011-04-29 09:59: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
ExceptionHandling.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.html Remove the C backend. 2012-03-23 05:50:46 +00:00
FAQ.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
GarbageCollection.html llvm/docs/GarbageCollection.html: Prune utf8 BOM. 2012-03-03 04:32:33 +00:00
GCCFEBuildInstrs.html docs: Introduce cascading style <div> and <p> continued on <h[2-5]>. 2011-04-23 00:30:22 +00:00
GetElementPtr.html docs/*.html: Fix markups. 2011-10-31 13:04:26 +00:00
GettingStarted.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
GettingStartedVS.html Tidy up. s/Low Level Virtual Machine/LLVM/. 2012-01-25 22:00:23 +00:00
GoldPlugin.html Recommend the -flto flag instead of -use-gold-plugin, and update 2011-11-05 04:17:28 +00:00
HowToAddABuilder.html Cleaned text, fixed HTML. 2011-11-03 05:57:26 +00:00
HowToReleaseLLVM.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
HowToSubmitABug.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
index.html Remove more GCC FE build stuff. 2012-02-26 22:26:37 +00:00
LangRef.html Remove support for the special 'fast' value for fpmath accuracy for the moment. 2012-04-16 19:39:33 +00:00
Lexicon.html test commit (verifyiing commit access) 2012-01-05 08:18:41 +00:00
LinkTimeOptimization.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
llvm.css docs/llvm.css: Introduce <blockquote><pre>. It may be used as blockquoted "doc_code". 2011-08-12 06:17:11 +00:00
LLVMBuild.html Documentation fixes to LLVMBuild.html [PR 11563] 2012-04-16 08:42:55 +00:00
LLVMBuild.txt LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +00:00
make.bat [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
Makefile Don't run ocamldoc if it's not installed 2011-02-09 18:32:04 +00:00
Makefile.sphinx [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
MakefileGuide.html docs: Introduce cascading style <div> and <p> continued on <h[2-5]>. 2011-04-23 00:30:22 +00:00
Packaging.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
Passes.html Add a basic-block autovectorization pass. 2012-02-01 03:51:43 +00:00
ProgrammersManual.html Document that StringMap iteration order is non-deterministic. 2012-04-18 20:28:55 +00:00
Projects.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
re_format.7
README.txt [docs] Stub out structure for Sphinx-based docs. 2012-04-19 16:31:19 +00:00
ReleaseNotes.html Add a stub about the inline cost rewrite. 2012-04-17 01:13:53 +00:00
SegmentedStacks.html Release notes for segmented stacks. 2011-11-29 19:08:23 +00:00
SourceLevelDebugging.html Add a line number for the scope of the function (starting at the first 2012-04-03 00:43:49 +00:00
SystemLibrary.html docs/*.html: Appease W3C Checker to add "charset=utf-8". 2011-10-31 11:21:59 +00:00
TableGenFundamentals.html llvm/docs/*.html: Fix markups. 2012-03-27 11:25:16 +00:00
TestingGuide.html A bit of cleanup in the TestingGuide doc - dg.exp files no longer exist 2012-04-18 08:02:25 +00:00
TestSuiteMakefileGuide.html docs: Update TestingGuide to change recommended practice to using LNT to drive 2012-03-15 22:19:35 +00:00
WritingAnLLVMBackend.html rplace Alpha with ARM in docs/WritingAnLLVMBackend.html, patch by chenwj 2012-03-01 15:14:19 +00:00
WritingAnLLVMPass.html Formatting changes. Don't put spaces in front of some code, which only makes it look 'off'. 2012-04-08 11:52:52 +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.