6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-12-28 19:31:58 +00:00
Code Issues Projects Releases Wiki Activity
1b8eeb327e
llvm-6502/docs
History
Chris Lattner 2ba4bd97d1 remove the rest of the "written by" lines in the documentation. It is 
against the developer policy to include this sort of thing as SVN blame
already captures this in a far more fine-grained way.



git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172109 91177308-0d34-0410-b5e6-96231b3b80d8
2013-01-10 21:24:04 +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
TableGen TableGen/LangRef: link bang operators into the productionlist 2013-01-09 02:20:31 +00:00
tutorial docs: Move link to the new "external tutorials" area. 2012-12-27 08:57:08 +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 remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
CompilerWriterInfo.rst Documentation: CompilerWriterInfo.rst: update link to Intel documentation 2012-12-13 20:02:11 +00:00
conf.py Update the copyright coredits -- Happy new year 2013! 2013-01-01 10:00:19 +00:00
DebuggingJITedCode.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
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 Update the copyright coredits -- Happy new year 2013! 2013-01-01 10:00:19 +00:00
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 docs: Add FAQ about "storing to a virtual register". 2012-12-27 10:23:04 +00:00
GarbageCollection.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
gcc-loops.png Update the gcc-loops benchmarks results with the new automatic unrolling feature. 2013-01-04 19:10:34 +00:00
GetElementPtr.rst Documentation: fix typos and formatting. 2012-12-06 21:12:35 +00:00
GettingStarted.rst docs: fix broken link. 2013-01-10 06:39:37 +00:00
GettingStartedVS.rst
GoldPlugin.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToAddABuilder.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToBuildOnARM.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToReleaseLLVM.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToSetUpLLVMStyleRTTI.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToSubmitABug.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
HowToUseInstrMappings.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
index.rst docs: Fix typo on front page 2012-10-04 04:41:27 +00:00
LangRef.rst Add a new attribute, 'noduplicate'. If a function contains a noduplicate call, the call cannot be duplicated - Jump threading, loop unrolling, loop unswitching, and loop rotation are inhibited if they would duplicate the call. 2012-12-20 16:04:27 +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
linpack-pc.png Add linpack-pc bench 2013-01-04 19:00:42 +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: fix typos reported in PR13866 2012-12-23 18:46:11 +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 remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +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 docs: update docs/README.txt and make it useful. 2013-01-02 02:31:51 +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 remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
SphinxQuickstartTemplate.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
subsystems.rst tblgen, docs: Add initial syntax reference. 2013-01-07 02:43:44 +00:00
SystemLibrary.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
TableGenFundamentals.rst fix a couple of typos 2013-01-04 19:09:15 +00:00
TestingGuide.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
TestSuiteMakefileGuide.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
userguides.rst Initial implementation of a utility for converting native data 2012-12-12 20:46:15 +00:00
Vectorizers.rst Docs: mention that we support float reductions when -ffast-math is used. 2013-01-08 17:46:30 +00:00
WritingAnLLVMBackend.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
WritingAnLLVMPass.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +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
==================

LLVM's documentation is written in reStructuredText, a lightweight
plaintext markup language (file extension `.rst`). While the
reStructuredText documentation should be quite readable in source form, it
is meant to be processed by the Sphinx documentation generation system to
create HTML pages which are hosted on <http://llvm.org/docs/> and updated
after every commit.

If you instead would like to generate and view the HTML locally, install
Sphinx <http://sphinx-doc.org/> and then do:

    cd docs/
    make -f Makefile.sphinx
    $BROWSER _build/html/index.html

The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `_build/html/Foo.html` <-> `http://llvm.org/docs/Foo.html`.

If you are interested in writing new documentation, you will want to read
`SphinxQuickstartTemplate.rst` which will get you writing documentation
very fast and includes examples of the most important reStructuredText
markup syntax.