llvm-mirror/docs at c2283c1bddada876b75ea3ea47d6180da9ad49ac · earl/llvm-mirror

This repository has been archived by the owner on Jan 1, 2023. It is now read-only.

Name		Name	Last commit message	Last commit date
parent directory ..
CommandGuide		CommandGuide
Frontend		Frontend
HistoricalNotes		HistoricalNotes
PDB		PDB
Proposals		Proposals
TableGen		TableGen
_ocamldoc		_ocamldoc
_static		_static
_templates		_templates
_themes/llvm-theme		_themes/llvm-theme
tutorial		tutorial
AMDGPUUsage.rst		AMDGPUUsage.rst
ARM-BE-bitcastfail.png		ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png		ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png		ARM-BE-ld1.png
ARM-BE-ldr.png		ARM-BE-ldr.png
AdvancedBuilds.rst		AdvancedBuilds.rst
AliasAnalysis.rst		AliasAnalysis.rst
Atomics.rst		Atomics.rst
Benchmarking.rst		Benchmarking.rst
BigEndianNEON.rst		BigEndianNEON.rst
BitCodeFormat.rst		BitCodeFormat.rst
BlockFrequencyTerminology.rst		BlockFrequencyTerminology.rst
BranchWeightMetadata.rst		BranchWeightMetadata.rst
Bugpoint.rst		Bugpoint.rst
CFIVerify.rst		CFIVerify.rst
CMake.rst		CMake.rst
CMakeLists.txt		CMakeLists.txt
CMakePrimer.rst		CMakePrimer.rst
CodeGenerator.rst		CodeGenerator.rst
CodeOfConduct.rst		CodeOfConduct.rst
CodingStandards.rst		CodingStandards.rst
CommandLine.rst		CommandLine.rst
CompileCudaWithLLVM.rst		CompileCudaWithLLVM.rst
CompilerWriterInfo.rst		CompilerWriterInfo.rst
Contributing.rst		Contributing.rst
Coroutines.rst		Coroutines.rst
CoverageMappingFormat.rst		CoverageMappingFormat.rst
DebuggingJITedCode.rst		DebuggingJITedCode.rst
DeveloperPolicy.rst		DeveloperPolicy.rst
Docker.rst		Docker.rst
ExceptionHandling.rst		ExceptionHandling.rst
ExtendedIntegerResults.txt		ExtendedIntegerResults.txt
ExtendingLLVM.rst		ExtendingLLVM.rst
Extensions.rst		Extensions.rst
FAQ.rst		FAQ.rst
FaultMaps.rst		FaultMaps.rst
FuzzingLLVM.rst		FuzzingLLVM.rst
GarbageCollection.rst		GarbageCollection.rst
GetElementPtr.rst		GetElementPtr.rst
GettingStarted.rst		GettingStarted.rst
GettingStartedVS.rst		GettingStartedVS.rst
GlobalISel.rst		GlobalISel.rst
GoldPlugin.rst		GoldPlugin.rst
HowToAddABuilder.rst		HowToAddABuilder.rst
HowToBuildOnARM.rst		HowToBuildOnARM.rst
HowToCrossCompileBuiltinsOnArm.rst		HowToCrossCompileBuiltinsOnArm.rst
HowToCrossCompileLLVM.rst		HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst		HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst		HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst		HowToSubmitABug.rst
HowToUseAttributes.rst		HowToUseAttributes.rst
HowToUseInstrMappings.rst		HowToUseInstrMappings.rst
InAlloca.rst		InAlloca.rst
LLVMBuild.rst		LLVMBuild.rst
LLVMBuild.txt		LLVMBuild.txt
LangRef.rst		LangRef.rst
Lexicon.rst		Lexicon.rst
LibFuzzer.rst		LibFuzzer.rst
LinkTimeOptimization.rst		LinkTimeOptimization.rst
MCJIT-creation.png		MCJIT-creation.png
MCJIT-dyld-load.png		MCJIT-dyld-load.png
MCJIT-engine-builder.png		MCJIT-engine-builder.png
MCJIT-load-object.png		MCJIT-load-object.png
MCJIT-load.png		MCJIT-load.png
MCJIT-resolve-relocations.png		MCJIT-resolve-relocations.png
MCJITDesignAndImplementation.rst		MCJITDesignAndImplementation.rst
MIRLangRef.rst		MIRLangRef.rst
Makefile.sphinx		Makefile.sphinx
MarkedUpDisassembly.rst		MarkedUpDisassembly.rst
MemorySSA.rst		MemorySSA.rst
MergeFunctions.rst		MergeFunctions.rst
NVPTXUsage.rst		NVPTXUsage.rst
OptBisect.rst		OptBisect.rst
Packaging.rst		Packaging.rst
Passes.rst		Passes.rst
Phabricator.rst		Phabricator.rst
ProgrammersManual.rst		ProgrammersManual.rst
Projects.rst		Projects.rst
README.txt		README.txt
ReleaseNotes.rst		ReleaseNotes.rst
ReleaseProcess.rst		ReleaseProcess.rst
ReportingGuide.rst		ReportingGuide.rst
ScudoHardenedAllocator.rst		ScudoHardenedAllocator.rst
SegmentedStacks.rst		SegmentedStacks.rst
SourceLevelDebugging.rst		SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst		SphinxQuickstartTemplate.rst
StackMaps.rst		StackMaps.rst
Statepoints.rst		Statepoints.rst
SystemLibrary.rst		SystemLibrary.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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs

docs

README.txt

Files

docs

Directory actions

More options

Directory actions

More options

Latest commit

History

docs

Folders and files

parent directory

README.txt