RPCS3/llvm
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm.git synced 2024-12-29 07:53:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d7407cd61e
llvm/docs
History
Chandler Carruth d7407cd61e Provide some actual highlight bullets for Clang. 
If anyone has better highlights (I'm obviously biased by the things that
I'm excited about) jump in and add them!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170194 91177308-0d34-0410-b5e6-96231b3b80d8
2012-12-14 13:22:57 +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
_themes/llvm-theme Sphinx CSS: remove negative letter-spacing, it makes some fonts look really 2012-09-30 20:43:24 +00:00
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 Fix a typo (the the => the) 2012-07-23 08:51:15 +00:00
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 Sphinxify the CommandLine document. 2012-08-08 08:21:24 +00:00
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 Fix Sphinx warnings. 2012-09-20 03:20:53 +00:00
design_and_overview.rst docs: Convert LangRef to reST. 2012-12-07 10:36:55 +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 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
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 Sphinxify the exception handling doc. 2012-06-27 07:20:57 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst docs: Propagate fix from r165632 to other docs. 2012-10-10 17:21:39 +00:00
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
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 Fix a typo (the the => the) 2012-07-23 08:51:15 +00:00
GoldPlugin.rst GoldPlugin.rst: minor typesetting fixes. 2012-10-05 20:50:05 +00:00
HowToAddABuilder.rst Patch by Sean Silva! 2012-09-13 23:51:08 +00:00
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 docs: Sphinxify HowToSubmitABug 2012-09-25 20:52:04 +00:00
HowToUseInstrMappings.rst Fix typo. 2012-11-15 21:21:01 +00:00
index.rst docs: Fix typo on front page 2012-10-04 04:41:27 +00:00
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 LLVMBuild: Remove trailing newline, which irked me. 2011-12-12 19:48:00 +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
Makefile [docs] Remove POD based man page docs (and build system support). 2012-05-08 17:48:21 +00:00
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 Sphinxify the outdated Packaging documentation. 2012-06-21 06:09:37 +00:00
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 Provide some actual highlight bullets for Clang. 2012-12-14 13:22:57 +00:00
SegmentedStacks.rst Sphinxify the SegmentedStack document. 2012-06-20 12:05:05 +00:00
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 Documentation: convert WritingAnLLVMPass.html to reST. 2012-12-12 17:02:44 +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
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 docs: Fix long-standing typo in yaml2obj.rst. 2012-09-21 19:48:16 +00:00
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.