mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-12-15 20:29:48 +00:00
72a81be374
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@171821 91177308-0d34-0410-b5e6-96231b3b80d8 |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| _themes/llvm-theme | ||
| CommandGuide | ||
| HistoricalNotes | ||
| TableGen | ||
| tutorial | ||
| AliasAnalysis.rst | ||
| Atomics.rst | ||
| BitCodeFormat.rst | ||
| BranchWeightMetadata.rst | ||
| Bugpoint.rst | ||
| CMake.rst | ||
| CodeGenerator.rst | ||
| CodingStandards.rst | ||
| CommandLine.rst | ||
| CompilerWriterInfo.rst | ||
| conf.py | ||
| DebuggingJITedCode.rst | ||
| design_and_overview.rst | ||
| DeveloperPolicy.rst | ||
| development_process.rst | ||
| doxygen.cfg.in | ||
| doxygen.css | ||
| doxygen.footer | ||
| doxygen.header | ||
| doxygen.intro | ||
| Dummy.html | ||
| ExceptionHandling.rst | ||
| ExtendedIntegerResults.txt | ||
| ExtendingLLVM.rst | ||
| FAQ.rst | ||
| GarbageCollection.rst | ||
| gcc-loops.png | ||
| GetElementPtr.rst | ||
| GettingStarted.rst | ||
| GettingStartedVS.rst | ||
| GoldPlugin.rst | ||
| HowToAddABuilder.rst | ||
| HowToBuildOnARM.rst | ||
| HowToReleaseLLVM.rst | ||
| HowToSetUpLLVMStyleRTTI.rst | ||
| HowToSubmitABug.rst | ||
| HowToUseInstrMappings.rst | ||
| index.rst | ||
| LangRef.rst | ||
| Lexicon.rst | ||
| LinkTimeOptimization.rst | ||
| linpack-pc.png | ||
| LLVMBuild.rst | ||
| LLVMBuild.txt | ||
| mailing_lists.rst | ||
| make.bat | ||
| Makefile | ||
| Makefile.sphinx | ||
| MakefileGuide.rst | ||
| MarkedUpDisassembly.rst | ||
| Packaging.rst | ||
| Passes.rst | ||
| Phabricator.rst | ||
| ProgrammersManual.rst | ||
| programming.rst | ||
| Projects.rst | ||
| re_format.7 | ||
| README.txt | ||
| ReleaseNotes.rst | ||
| SegmentedStacks.rst | ||
| SourceLevelDebugging.rst | ||
| SphinxQuickstartTemplate.rst | ||
| subsystems.rst | ||
| SystemLibrary.rst | ||
| TableGenFundamentals.rst | ||
| TestingGuide.rst | ||
| TestSuiteMakefileGuide.rst | ||
| userguides.rst | ||
| Vectorizers.rst | ||
| WritingAnLLVMBackend.rst | ||
| WritingAnLLVMPass.rst | ||
| yaml2obj.rst | ||
| YamlIO.rst | ||
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.