llvm/docs at 8efd0f00beb4002940c341250c7db23fbe8ac2c1 - llvm

RPCS3/llvm

mirror of https://github.com/RPCS3/llvm.git synced 2024-12-12 14:20:33 +00:00

History

Nadav Rotem f9962d9391 doc: resize the image. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170622 91177308-0d34-0410-b5e6-96231b3b80d8		2012-12-20 00:29:18 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide	Documentation: use paths relative to document root in links.	2012-12-12 21:16:29 +00:00
HistoricalNotes
tutorial	docs: Sphinxify `docs/tutorial/`	2012-12-05 00:26:32 +00:00
AliasAnalysis.rst	Documentation: AliasAnalysis.rst: improve internal and external links	2012-12-12 17:03:50 +00:00
Atomics.rst
BitCodeFormat.rst	Better 80cols... sigh	2012-11-20 18:14:15 +00:00
BranchWeightMetadata.rst	Fixed some grammar and punctuation error.	2012-12-07 19:21:10 +00:00
Bugpoint.rst	Documentation: use a 'console' highlighter for terminal output examples. This	2012-12-12 14:23:14 +00:00
CMake.rst	Documentation: convert WritingAnLLVMPass.html to reST.	2012-12-12 17:02:44 +00:00
CodeGenerator.rst	Documentation: convert ReleaseNotes.html to reST.	2012-12-09 23:14:26 +00:00
CodingStandards.rst	Simplify the coding standards for #include ordering. The ordering is now	2012-12-02 11:53:27 +00:00
CommandLine.rst
CompilerWriterInfo.rst	Documentation: CompilerWriterInfo.rst: update link to Intel documentation	2012-12-13 20:02:11 +00:00
conf.py	Bump sphinx config to 3.3.	2012-11-17 22:12:59 +00:00
DebuggingJITedCode.rst
design_and_overview.rst	Documentation: add a missing space	2012-12-19 12:51:48 +00:00
DeveloperPolicy.rst	Documentation: convert ReleaseNotes.html to reST.	2012-12-09 23:14:26 +00:00
development_process.rst	Convert HowToReleaseLLVM.html to reST	2012-12-07 16:42:48 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html	Add a dummy documentation file to unbreak 'make install'. We need to find how	2012-12-13 13:37:35 +00:00
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
FAQ.rst	Documentation: use a 'console' highlighter for terminal output examples. This	2012-12-12 13:56:37 +00:00
GarbageCollection.rst	Documentation: convert WritingAnLLVMPass.html to reST.	2012-12-12 17:02:44 +00:00
gcc-loops.png	doc: resize the image.	2012-12-20 00:29:18 +00:00
GetElementPtr.rst	Documentation: fix typos and formatting.	2012-12-06 21:12:35 +00:00
GettingStarted.rst	Documentation: use a 'console' highlighter for terminal output examples. This	2012-12-12 13:56:37 +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.rst	Documentation: HowToReleaseLLVM.rst: remove trailing whitespace.	2012-12-09 15:33:26 +00:00
HowToSetUpLLVMStyleRTTI.rst	docs: Update example to conform to coding standards.	2012-10-12 01:55:51 +00:00
HowToSubmitABug.rst
HowToUseInstrMappings.rst	Fix typo.	2012-11-15 21:21:01 +00:00
index.rst
LangRef.rst	So many people have touched this, it doesn't make sense to ascribe authorship anymore.	2012-12-09 16:55:39 +00:00
Lexicon.rst	Documentation: Lexicon.rst: add 'SLP' acronym	2012-12-11 23:13:23 +00:00
LinkTimeOptimization.rst	Documentation: cleanup	2012-12-12 16:58:13 +00:00
LLVMBuild.rst	docs: Sphinxify LLVMBuild documentation.	2012-11-20 03:13:53 +00:00
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx	Makefile.sphinx: reST conversion is complete!	2012-12-12 21:35:43 +00:00
MakefileGuide.rst	Documentation: convert WritingAnLLVMPass.html to reST.	2012-12-12 17:02:44 +00:00
MarkedUpDisassembly.rst	Add a bit of documentation on the annotated disassembly output.	2012-10-24 23:30:22 +00:00
Packaging.rst
Passes.rst	Documentation: convert Passes.html to reST.	2012-12-11 15:29:37 +00:00
Phabricator.rst	docs: use code font for console commands in phabricator manual	2012-11-06 15:04:37 +00:00
ProgrammersManual.rst	docs: Fix broken link.	2012-12-04 03:45:27 +00:00
programming.rst	docs: Convert ProgrammersManual to reST.	2012-12-04 03:20:08 +00:00
Projects.rst	docs: Sphinxify TestingGuide	2012-11-14 21:09:30 +00:00
re_format.7
README.txt	test commit: verifying access from new address	2012-10-18 18:12:05 +00:00
ReleaseNotes.rst	Actually update the grammar of this sentence to reflect the removal of CellSPU.	2012-12-15 08:56:20 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst	Some grammar fixes	2012-11-28 00:27:25 +00:00
SphinxQuickstartTemplate.rst	docs: Improve discussion of syntax highlighting.	2012-12-13 20:14:25 +00:00
subsystems.rst	DOC: Add a webpage that describes the loop and bb vectorizers.	2012-12-19 07:22:24 +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	Get rid of references to Tcl, DejagGNU, old test structure, discourage the use	2012-12-04 14:34:00 +00:00
TestSuiteMakefileGuide.rst	docs: Sphinxify TestSuiteMakefileGuide	2012-11-14 23:11:10 +00:00
userguides.rst	Initial implementation of a utility for converting native data	2012-12-12 20:46:15 +00:00
Vectorizers.rst	Doc: update the chart.	2012-12-20 00:03:36 +00:00
WritingAnLLVMBackend.rst	Documentation: convert WritingAnLLVMPass.html to reST.	2012-12-12 17:02:44 +00:00
WritingAnLLVMPass.rst	Documentation: convert WritingAnLLVMPass.html to reST.	2012-12-12 17:02:44 +00:00
yaml2obj.rst
YamlIO.rst	Initial implementation of a utility for converting native data	2012-12-12 20:46:15 +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.