llvm-6502

mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-11-06 05:06:45 +00:00

History

Sean Silva b63ae85382 docs: Explain plain preformatted text git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169352 91177308-0d34-0410-b5e6-96231b3b80d8		2012-12-05 04:07:33 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide	Update FileCheck's documentation to mention recently added feature of	2012-12-01 22:03:57 +00:00
HistoricalNotes
tutorial	docs: Sphinxify `docs/tutorial/`	2012-12-05 00:26:32 +00:00
AliasAnalysis.rst
Atomics.rst
BitCodeFormat.rst	Better 80cols... sigh	2012-11-20 18:14:15 +00:00
BranchWeightMetadata.rst
Bugpoint.rst
CMake.rst
CodeGenerator.rst	Documentation: convert WritingAnLLVMBackend.html to reST	2012-12-01 12:13:48 +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	Update link to external document	2012-11-12 23:43:34 +00:00
conf.py	Bump sphinx config to 3.3.	2012-11-17 22:12:59 +00:00
DebuggingJITedCode.rst
design_and_overview.rst
DeveloperPolicy.rst	docs: Sphinxify TestingGuide	2012-11-14 21:09:30 +00:00
development_process.rst	docs: Sphinxify LLVMBuild documentation.	2012-11-20 03:13:53 +00:00
doxygen.cfg.in
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst
ExtendedIntegerResults.txt
ExtendingLLVM.rst
FAQ.rst
GarbageCollection.html
GetElementPtr.rst
GettingStarted.rst	docs: [CMake] Add Xcode to the list of project formats CMake can generate.	2012-11-27 23:34:28 +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.html
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.html	Removed redundancy in wording	2012-11-30 23:14:52 +00:00
Lexicon.rst	Documentation: Lexicon.rst: add "BB Vectorization" and "TBAA".	2012-10-13 17:34:49 +00:00
LinkTimeOptimization.rst
LLVMBuild.rst	docs: Sphinxify LLVMBuild documentation.	2012-11-20 03:13:53 +00:00
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx	docs: Sphinxify `docs/tutorial/`	2012-12-05 00:26:32 +00:00
MakefileGuide.rst	docs: Sphinxify TestingGuide	2012-11-14 21:09:30 +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.html	Remove 'sretpromotion' pass from the documentation. This pass is long	2012-11-22 11:17:08 +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.html	Update release notes for NVPTX	2012-12-04 16:11:51 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst	Some grammar fixes	2012-11-28 00:27:25 +00:00
SphinxQuickstartTemplate.rst	docs: Explain plain preformatted text	2012-12-05 04:07:33 +00:00
subsystems.rst	Documentation: convert WritingAnLLVMBackend.html to reST	2012-12-01 12:13:48 +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	docs: Begin Sphinxification of docs/tutorial/	2012-12-04 21:16:41 +00:00
WritingAnLLVMBackend.rst	Documentation: convert WritingAnLLVMBackend.html to reST	2012-12-01 12:13:48 +00:00
WritingAnLLVMPass.html
yaml2obj.rst

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.