llvm-mirror

mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-12-13 06:29:59 +00:00

History

Michael J. Spencer 9f255feb3f Add yaml2obj. A utility to convert YAML to binaries. yaml2obj takes a textual description of an object file in YAML format and outputs the binary equivalent. This greatly simplifies writing tests that take binary object files as input. llvm-svn: 161205		2012-08-02 19:16:56 +00:00
..
_static
_templates
CommandGuide	Fix a typo (the the => the)	2012-07-23 08:51:15 +00:00
HistoricalNotes
llvm-theme
tutorial	Fix some minor typos	2012-07-31 07:05:57 +00:00
AliasAnalysis.rst
Atomics.rst	Fix a typo (the the => the)	2012-07-23 08:51:15 +00:00
BitCodeFormat.rst	Sphinxify the bitcode format document.	2012-06-28 08:43:12 +00:00
BranchWeightMetadata.rst
Bugpoint.rst	Sphyinxify the Bugpoint document.	2012-06-26 11:37:00 +00:00
CMake.rst	Fixup broken doc link. Patch by Sean Silva <silvas@purdue.edu>.	2012-07-11 21:49:14 +00:00
CodeGenerator.rst	Sphinxify the Code Generator document.	2012-08-02 08:49:53 +00:00
CodingStandards.rst	Put space after "code-block::".	2012-06-20 23:57:00 +00:00
CommandLine.html	The TimePassesIsEnabled has since moved to PassManager.cpp.	2012-07-27 19:03:02 +00:00
CompilerWriterInfo.html
conf.py
DebuggingJITedCode.html
design_and_overview.rst	Sphixify the GEP FAQ.	2012-06-20 21:54:22 +00:00
DeveloperPolicy.rst	Take people straight to the contents of the file.	2012-07-26 08:08:31 +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
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
ExceptionHandling.rst	Sphinxify the exception handling doc.	2012-06-27 07:20:57 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.html
FAQ.rst
GarbageCollection.html
GCCFEBuildInstrs.html
GetElementPtr.rst	Sphixify the GEP FAQ.	2012-06-20 21:54:22 +00:00
GettingStarted.html	Fix a typo (the the => the)	2012-07-23 08:51:15 +00:00
GettingStartedVS.rst	Fix a typo (the the => the)	2012-07-23 08:51:15 +00:00
GoldPlugin.html
HowToAddABuilder.html
HowToReleaseLLVM.html	Fix some minor typos	2012-07-31 07:05:57 +00:00
HowToSubmitABug.html
index.rst
LangRef.html	Add a floor intrinsic.	2012-07-26 17:43:27 +00:00
Lexicon.rst
LinkTimeOptimization.rst
LLVMBuild.html
LLVMBuild.txt
mailing_lists.rst
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst
Packaging.rst	Sphinxify the outdated Packaging documentation.	2012-06-21 06:09:37 +00:00
Passes.html	Fix two typos in the doc	2012-07-25 22:01:31 +00:00
ProgrammersManual.html	Twine: fix link to source, add link to class doc and container section.	2012-07-25 13:46:11 +00:00
programming.rst	Move coding standards reference from development_process.rst to programming.rst.	2012-06-20 11:56:24 +00:00
Projects.rst	Fix grammar-o. Fixes PR13482!	2012-07-30 21:10:51 +00:00
re_format.7
README.txt
ReleaseNotes.html	ReleaseNotes.html: add note about specifying TLS models	2012-07-13 12:44:23 +00:00
SegmentedStacks.rst	Sphinxify the SegmentedStack document.	2012-06-20 12:05:05 +00:00
SourceLevelDebugging.html
subsystems.rst	Sphinxify the Code Generator document.	2012-08-02 08:49:53 +00:00
SystemLibrary.html
TableGenFundamentals.rst	Cleanup some encoding mishaps.	2012-06-21 07:01:02 +00:00
TestingGuide.html
TestSuiteMakefileGuide.html	Fix some minor typos	2012-07-31 07:05:57 +00:00
userguides.rst	Fixup broken doc link. Patch by Sean Silva <silvas@purdue.edu>.	2012-07-11 21:49:14 +00:00
WritingAnLLVMBackend.html
WritingAnLLVMPass.html
yaml2obj.rst	Add yaml2obj. A utility to convert YAML to binaries.	2012-08-02 19:16:56 +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.