forked from OSchip/llvm-project
90c57e0001
Previously, the llvm-readelf documentation was essentially just a list of differences to llvm-readobj. Since llvm-readelf is the more likely goto tool for many people migrating to the LLVM toolchain, it seems like it would be helpful to document all the switches in the llvm-readelf document too. This change expands the options listed accordingly. Additionally, they are unlikely to care what the differences are to llvm-readobj, since they won't be familiar with the latter as there is no GNU equivalent, so this change moves the "differences" section to llvm-readobj's documentation. Reviewed by: peter.smith Differential Revision: https://reviews.llvm.org/D63826 llvm-svn: 364800 |
||
|---|---|---|
| .. | ||
| AMDGPU | ||
| CommandGuide | ||
| Frontend | ||
| HistoricalNotes | ||
| PDB | ||
| Proposals | ||
| TableGen | ||
| _ocamldoc | ||
| _static | ||
| _templates | ||
| _themes/llvm-theme | ||
| tutorial | ||
| AMDGPUInstructionNotation.rst | ||
| AMDGPUInstructionSyntax.rst | ||
| AMDGPUModifierSyntax.rst | ||
| AMDGPUOperandSyntax.rst | ||
| AMDGPUUsage.rst | ||
| ARM-BE-bitcastfail.png | ||
| ARM-BE-bitcastsuccess.png | ||
| ARM-BE-ld1.png | ||
| ARM-BE-ldr.png | ||
| AddingConstrainedIntrinsics.rst | ||
| AdvancedBuilds.rst | ||
| AliasAnalysis.rst | ||
| Atomics.rst | ||
| Benchmarking.rst | ||
| BigEndianNEON.rst | ||
| BitCodeFormat.rst | ||
| BlockFrequencyTerminology.rst | ||
| BranchWeightMetadata.rst | ||
| BugLifeCycle.rst | ||
| Bugpoint.rst | ||
| BuildingADistribution.rst | ||
| CFIVerify.rst | ||
| CMake.rst | ||
| CMakeLists.txt | ||
| CMakePrimer.rst | ||
| CodeGenerator.rst | ||
| CodeOfConduct.rst | ||
| CodingStandards.rst | ||
| CommandLine.rst | ||
| CompileCudaWithLLVM.rst | ||
| CompilerWriterInfo.rst | ||
| Contributing.rst | ||
| Coroutines.rst | ||
| CoverageMappingFormat.rst | ||
| DebuggingJITedCode.rst | ||
| DeveloperPolicy.rst | ||
| Docker.rst | ||
| ExceptionHandling.rst | ||
| ExtendedIntegerResults.txt | ||
| ExtendingLLVM.rst | ||
| Extensions.rst | ||
| FAQ.rst | ||
| FaultMaps.rst | ||
| FuzzingLLVM.rst | ||
| GarbageCollection.rst | ||
| GetElementPtr.rst | ||
| GettingStarted.rst | ||
| GettingStartedVS.rst | ||
| GlobalISel.rst | ||
| GoldPlugin.rst | ||
| HowToAddABuilder.rst | ||
| HowToBuildOnARM.rst | ||
| HowToBuildWithPGO.rst | ||
| HowToCrossCompileBuiltinsOnArm.rst | ||
| HowToCrossCompileLLVM.rst | ||
| HowToReleaseLLVM.rst | ||
| HowToSetUpLLVMStyleRTTI.rst | ||
| HowToSubmitABug.rst | ||
| HowToUseAttributes.rst | ||
| HowToUseInstrMappings.rst | ||
| InAlloca.rst | ||
| LLVMBuild.rst | ||
| LLVMBuild.txt | ||
| LangRef.rst | ||
| Lexicon.rst | ||
| LibFuzzer.rst | ||
| LinkTimeOptimization.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 | ||
| MIRLangRef.rst | ||
| Makefile.sphinx | ||
| MarkdownQuickstartTemplate.md | ||
| MarkedUpDisassembly.rst | ||
| MeetupGuidelines.rst | ||
| MemorySSA.rst | ||
| MergeFunctions.rst | ||
| NVPTXUsage.rst | ||
| ORCv2DesignAndImplementation.rst | ||
| OptBisect.rst | ||
| Packaging.rst | ||
| Passes.rst | ||
| Phabricator.rst | ||
| ProgrammersManual.rst | ||
| Projects.rst | ||
| README.txt | ||
| ReleaseNotes.rst | ||
| ReleaseProcess.rst | ||
| ReportingGuide.rst | ||
| ScudoHardenedAllocator.rst | ||
| SegmentedStacks.rst | ||
| SourceLevelDebugging.rst | ||
| SpeculativeLoadHardening.md | ||
| SphinxQuickstartTemplate.rst | ||
| StackMaps.rst | ||
| StackSafetyAnalysis.rst | ||
| Statepoints.rst | ||
| SupportLibrary.rst | ||
| SystemLibrary.rst | ||
| TableGenFundamentals.rst | ||
| TestSuiteGuide.md | ||
| TestSuiteMakefileGuide.rst | ||
| TestingGuide.rst | ||
| TransformMetadata.rst | ||
| TypeMetadata.rst | ||
| Vectorizers.rst | ||
| WritingAnLLVMBackend.rst | ||
| WritingAnLLVMPass.rst | ||
| XRay.rst | ||
| XRayExample.rst | ||
| XRayFDRFormat.rst | ||
| YamlIO.rst | ||
| conf.py | ||
| doxygen-mainpage.dox | ||
| doxygen.cfg.in | ||
| gcc-loops.png | ||
| index.rst | ||
| linpack-pc.png | ||
| llvm-objdump.1 | ||
| make.bat | ||
| re_format.7 | ||
| speculative_load_hardening_microbenchmarks.png | ||
| yaml2obj.rst | ||
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 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 <build-dir>
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_HTML=true <src-dir>
make -j3 docs-llvm-html
$BROWSER <build-dir>/docs//html/index.html
The mapping between reStructuredText files and generated documentation is
`docs/Foo.rst` <-> `<build-dir>/docs//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-dir>/docs/man/`.
cd <build-dir>
cmake -DLLVM_ENABLE_SPHINX=true -DSPHINX_OUTPUT_MAN=true <src-dir>
make -j3 docs-llvm-man
man -l >build-dir>/docs/man/FileCheck.1
The correspondence between .rst files and man pages is
`docs/CommandGuide/Foo.rst` <-> `<build-dir>/docs//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 reachability of external links in the documentation can be checked by
running:
cd docs/
make -f Makefile.sphinx linkcheck
Doxygen page Output
==============
Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.
cd <build-dir>
cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
make doxygen-llvm # for LLVM docs
make doxygen-clang # for clang docs
It will generate html in
<build-dir>/docs/doxygen/html # for LLVM docs
<build-dir>/tools/clang/docs/doxygen/html # for clang docs