mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-21 18:29:46 +00:00
This commit starts with a "git mv ARM64 AArch64" and continues out from there, renaming the C++ classes, intrinsics, and other target-local objects for consistency. "ARM64" test directories are also moved, and tests that began their life in ARM64 use an arm64 triple, those from AArch64 use an aarch64 triple. Both should be equivalent though. This finishes the AArch64 merge, and everyone should feel free to continue committing as normal now. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@209577 91177308-0d34-0410-b5e6-96231b3b80d8 |
||
---|---|---|
.. | ||
_static | ||
_templates | ||
_themes/llvm-theme | ||
CommandGuide | ||
HistoricalNotes | ||
TableGen | ||
tutorial | ||
AliasAnalysis.rst | ||
ARM-BE-bitcastfail.png | ||
ARM-BE-bitcastsuccess.png | ||
ARM-BE-ld1.png | ||
ARM-BE-ldr.png | ||
Atomics.rst | ||
BigEndianNEON.rst | ||
BitCodeFormat.rst | ||
BlockFrequencyTerminology.rst | ||
BranchWeightMetadata.rst | ||
Bugpoint.rst | ||
CMake.rst | ||
CMakeLists.txt | ||
CodeGenerator.rst | ||
CodingStandards.rst | ||
CommandLine.rst | ||
CompilerWriterInfo.rst | ||
conf.py | ||
DebuggingJITedCode.rst | ||
DeveloperPolicy.rst | ||
doxygen.cfg.in | ||
doxygen.css | ||
doxygen.footer | ||
doxygen.header | ||
doxygen.intro | ||
Dummy.html | ||
ExceptionHandling.rst | ||
ExtendedIntegerResults.txt | ||
ExtendingLLVM.rst | ||
Extensions.rst | ||
FAQ.rst | ||
GarbageCollection.rst | ||
gcc-loops.png | ||
GetElementPtr.rst | ||
GettingStarted.rst | ||
GettingStartedVS.rst | ||
GoldPlugin.rst | ||
HowToAddABuilder.rst | ||
HowToBuildOnARM.rst | ||
HowToCrossCompileLLVM.rst | ||
HowToReleaseLLVM.rst | ||
HowToSetUpLLVMStyleRTTI.rst | ||
HowToSubmitABug.rst | ||
HowToUseAttributes.rst | ||
HowToUseInstrMappings.rst | ||
InAlloca.rst | ||
index.rst | ||
LangRef.rst | ||
Lexicon.rst | ||
LinkTimeOptimization.rst | ||
linpack-pc.png | ||
LLVMBuild.rst | ||
LLVMBuild.txt | ||
make.bat | ||
Makefile | ||
Makefile.sphinx | ||
MakefileGuide.rst | ||
MarkedUpDisassembly.rst | ||
MCJIT-creation.png | ||
MCJIT-dyld-load.png | ||
MCJIT-engine-builder.png | ||
MCJIT-load-object.png | ||
MCJIT-load.png | ||
MCJIT-resolve-relocations.png | ||
MCJITDesignAndImplementation.rst | ||
NVPTXUsage.rst | ||
Packaging.rst | ||
Passes.rst | ||
Phabricator.rst | ||
ProgrammersManual.rst | ||
Projects.rst | ||
re_format.7 | ||
README.txt | ||
ReleaseNotes.rst | ||
ReleaseProcess.rst | ||
SegmentedStacks.rst | ||
SourceLevelDebugging.rst | ||
SphinxQuickstartTemplate.rst | ||
StackMaps.rst | ||
SystemLibrary.rst | ||
TableGenFundamentals.rst | ||
TestingGuide.rst | ||
TestSuiteMakefileGuide.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 mostly 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. Manpage output is also supported, see below. 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. Manpage Output =============== Building the manpages is similar to building the HTML documentation. The primary difference is to use the `man` makefile target, instead of the default (which is `html`). Sphinx then produces the man pages in the directory `_build/man/`. cd docs/ make -f Makefile.sphinx man man -l _build/man/FileCheck.1 The correspondence between .rst files and man pages is `docs/CommandGuide/Foo.rst` <-> `_build/man/Foo.1`. These .rst files are also included during HTML generation so they are also viewable online (as noted above) at e.g. `http://llvm.org/docs/CommandGuide/Foo.html`. Checking links ============== The reachibility of external links in the documentation can be checked by running: cd docs/ make -f Makefile.sphinx linkcheck