llvm-project/llvm/docs
Zola Bridges b2d733c350 [llvm][docs] Add step by step git to GettingStarted
Summary:
Due to deleting the git llvm script, folks were asking for better documentation
about how to use git in order to commit to the Github repo. I added some step
by step git commands to make the usage clearer.

Context link: http://lists.llvm.org/pipermail/llvm-dev/2020-May/141640.html

Reviewed By: spatel, mehdi_amini

Differential Revision: https://reviews.llvm.org/D80088
2020-05-19 12:14:17 -07:00
..
AMDGPU [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2020-02-07 16:23:46 +03:00
CommandGuide [dsymutil] Make sure the --help output and man page are consistent 2020-05-18 11:38:36 -07:00
DependenceGraphs [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
Frontend update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
GlobalISel [NFC] G_DYN_STACKALLOC realign iff align > 1, update documentation 2020-04-03 08:12:39 +00:00
HistoricalNotes Doc: Links should use https 2020-03-22 22:49:33 +01:00
PDB Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
Proposals [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
TableGen [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
_ocamldoc
_static
_templates [www] More HTTPS and outdated link fixes. 2019-11-08 14:41:27 -08:00
_themes/llvm-theme [Docs] Updates sidebar links and sets max-width property for div.body 2019-10-15 21:27:20 +00:00
tutorial [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
AMDGPUDwarfProposalForHeterogeneousDebugging.rst [AMDGPU] Update DWARF proposal encodings 2020-04-30 14:02:54 -04:00
AMDGPUInstructionNotation.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler description. 2018-12-28 11:48:23 +00:00
AMDGPUInstructionSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-07-08 16:50:11 +00:00
AMDGPUModifierSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-12-25 17:51:53 +03:00
AMDGPUOperandSyntax.rst [AMDGPU][MC][DOC] Updated AMD GPU assembler syntax description. 2019-12-25 17:51:53 +03:00
AMDGPUUsage.rst [AMDGPU] Enable base pointer. 2020-05-17 16:13:55 +05:30
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
AddingConstrainedIntrinsics.rst [FEnv] Fix AddingConstrainedIntrinsics.rst after llvmorg-10-init-10282-g0c50c0b0552 2019-11-19 23:09:13 -08:00
AdvancedBuilds.rst Use backquotes to avoid a sphinx unexpected error: 2018-12-16 14:19:39 +00:00
AliasAnalysis.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
Atomics.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
Benchmarking.rst
BigEndianNEON.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BitCodeFormat.rst [IR][BFloat] Add BFloat IR type 2020-05-15 14:43:43 +01:00
BlockFrequencyTerminology.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BranchWeightMetadata.rst
BugLifeCycle.rst
Bugpoint.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
BugpointRedesign.md [Bugpoint redesign] Fix nonlocal URI link in doc 2019-08-09 21:48:47 +00:00
BuildingADistribution.rst Remove AllTargetsAsmPrinters 2020-01-17 19:04:06 -05:00
CFIVerify.rst
CMake.rst [dfsan] Add "DataFlow" option to LLVM_USE_SANITIZER 2020-04-20 10:30:52 -07:00
CMakeLists.txt
CMakePrimer.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
CodeGenerator.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
CodeOfConduct.rst
CodeReview.rst High-Level Code-Review Documentation Update 2020-03-07 04:20:18 +00:00
CodingStandards.rst [docs] Document coding standard for error and warning messages 2020-03-31 12:41:17 +01:00
CommandLine.rst [CommandLine] Add callbacks to Options 2019-12-06 15:16:45 -08:00
CompileCudaWithLLVM.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
CompilerWriterInfo.rst [PowerPC][docs] Update Embedded PowerPC docs in Compiler Writers Info page 2019-12-30 20:22:37 +00:00
Contributing.rst High-Level Code-Review Documentation Update 2020-03-07 04:20:18 +00:00
Coroutines.rst fix another doc typo to cycle bots 2019-12-20 21:59:51 -05:00
CoverageMappingFormat.rst Reland: [Coverage] Revise format to reduce binary size 2020-02-28 18:12:04 -08:00
DebuggingJITedCode.rst [docs] Fix references to a renamed flag. 2019-11-06 14:42:57 -08:00
DeveloperPolicy.rst [docs] use git diff instead of git format-patch 2020-04-02 07:20:27 -07:00
Docker.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
ExceptionHandling.rst Remove extra "\01" prefix in EH docs 2020-01-19 08:20:17 -08:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst Note ImmArg in documentation for adding intrinsics 2019-03-14 13:46:17 +00:00
Extensions.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
FAQ.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
FaultMaps.rst
FuzzingLLVM.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
GarbageCollection.rst [AsmPrinter] De-capitalize all AsmPrinter::Emit* but EmitInstruction 2020-02-13 17:06:24 -08:00
GetElementPtr.rst [DOC] Fix `load` instructions' syntax, function definition. 2019-06-12 11:24:22 +00:00
GettingInvolved.rst Add the CodeReview Documentation to GettingInvolved TOC 2020-03-07 04:55:46 +00:00
GettingStarted.rst [llvm][docs] Add step by step git to GettingStarted 2020-05-19 12:14:17 -07:00
GettingStartedTutorials.rst [Docs] Adds Documentation links to sidebar 2019-10-09 20:26:13 +00:00
GettingStartedVS.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
GitBisecting.rst git bisect docs: formatting tweaks 2020-02-10 15:47:59 -05:00
GoldPlugin.rst
GwpAsan.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToAddABuilder.rst [docs] Add link to zorg github project 2020-05-13 13:41:16 -07:00
HowToBuildOnARM.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToBuildWithPGO.rst [docs] NFC: Fix typos in documents 2020-01-07 16:06:14 +01:00
HowToCrossCompileBuiltinsOnArm.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
HowToCrossCompileLLVM.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
HowToReleaseLLVM.rst Remove some autoconf references from docs and comments 2019-07-03 09:57:59 +00:00
HowToSetUpLLVMStyleRTTI.rst [docs] Fix an RST error introduced in e823068306. 2020-04-15 14:37:58 -07:00
HowToSubmitABug.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
HowToUseAttributes.rst
HowToUseInstrMappings.rst [llvm] NFC: Fix trivial typo in rst and td files 2020-04-23 14:26:32 +09:00
InAlloca.rst
LLVMBuild.rst
LLVMBuild.txt Doc: Links should use https 2020-03-22 22:49:33 +01:00
LangRef.rst [IR] Convert null-pointer-is-valid into an enum attribute 2020-05-15 19:41:07 +02:00
Lexicon.rst [Lexicon] fix typo "may is" -> "is" 2020-04-26 19:35:25 +01:00
LibFuzzer.rst doc: use the right url to bugzilla 2020-03-22 22:49:40 +01:00
LinkTimeOptimization.rst [LTO][Legacy] Add new API to query Mach-O CPU (sub)type 2020-02-28 12:56:05 -08:00
LoopTerminology.rst [LoopTerminology] LCSSA: Fix typo in code sample 2020-04-12 04:40:55 +03:00
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 [globalisel][docs] Rework GMIR documentation and add an early GenericOpcode reference 2019-11-05 15:16:43 -08:00
Makefile.sphinx
MarkdownQuickstartTemplate.md Doc: Links should use https 2020-03-22 22:49:33 +01:00
MarkedUpDisassembly.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
MeetupGuidelines.rst Add guidelines/recommendations for organizers of LLVM Socials 2019-05-14 07:20:58 +00:00
MemTagSanitizer.rst Fix MemTagSanitizer docs to point at Armv8.5-A MTE 2020-03-05 17:23:58 +00:00
MemorySSA.rst
MergeFunctions.rst MergeFunctions.rst - multiply vs shift typo (PR44717) 2020-03-23 10:13:25 +00:00
NVPTXUsage.rst
ORCv2.rst [ORC] Update ORCv2 docs to reflect removal of ExecutionSession::getMainJITDylib. 2020-04-13 12:52:44 -07:00
OptBisect.rst [LegacyPassManager] Delete BasicBlockPass/Manager. 2019-10-30 11:40:16 -07:00
Packaging.rst update of the llvm doc: we moved to git 2020-03-22 22:36:21 +01:00
Passes.rst [LoopTerminology] LCSSA form 2020-03-31 15:30:59 +03:00
Phabricator.rst Add mention of advantages of `arc` in the Phabricator doc. 2020-04-04 03:22:29 +00:00
ProgrammersManual.rst [CallSite removal] Remove the text describing CallSite from the manual. 2020-04-23 22:17:19 -04:00
Projects.rst
README.txt Doc: Links should use https 2020-03-22 22:49:33 +01:00
Reference.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
ReleaseNotes.rst [Docs] Fixed formatting in release notes, NFC 2020-04-22 18:25:22 +01:00
ReleaseProcess.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
Remarks.rst [Remarks] Extend the RemarkStreamer to support other emitters 2020-02-04 17:16:02 -08:00
ReportingGuide.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
ScudoHardenedAllocator.rst [docs] Scudo: document error messages & their potential cause 2019-01-22 16:43:45 +00:00
SegmentedStacks.rst
SourceLevelDebugging.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
SpeculativeLoadHardening.md Fix a few spellos in docs. 2019-09-13 14:58:24 +00:00
SphinxQuickstartTemplate.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
StackMaps.rst
StackSafetyAnalysis.rst Remove trailing empty line 2018-11-26 23:17:52 +00:00
Statepoints.rst [DOC] Remove too strong restriction for ‘llvm.experimental.gc.statepoint’ Intrinsic 2020-04-02 10:56:42 +07:00
SupportLibrary.rst
SystemLibrary.rst
TableGenFundamentals.rst
TestSuiteGuide.md Doc: Links should use https 2020-03-22 22:49:33 +01:00
TestSuiteMakefileGuide.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
TestingGuide.rst NFC: Fix typos in TestingGuide documentation 2020-03-24 14:54:55 -04:00
TransformMetadata.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
TypeMetadata.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
UserGuides.rst [AMDGPU] Move DWARF proposal to separate file 2020-04-15 17:19:39 -04:00
Vectorizers.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
WritingAnLLVMBackend.rst Update spelling of {analyze,insert,remove}Branch in strings and comments 2020-01-21 10:15:38 -06:00
WritingAnLLVMPass.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
XRay.rst
XRayExample.rst [XRay][docs] Fix option name 2019-03-12 13:44:42 +00:00
XRayFDRFormat.rst [llvm] NFC: fix trivial typos in documents 2020-01-22 11:32:51 +08:00
YamlIO.rst remove a trailing space character (test commit) 2020-01-27 15:01:55 -08:00
conf.py [Docs] Add a custom sidebar to doc pages 2019-09-20 22:16:39 +00:00
doxygen-mainpage.dox
doxygen.cfg.in [docs] update mathjax path in doxygen 2020-02-07 16:26:35 +00:00
gcc-loops.png
index.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
linpack-pc.png
llvm-objdump.1 Update the file headers across all of the LLVM projects in the monorepo 2019-01-19 08:50:56 +00:00
loop-terminology-guarded-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
loop-terminology-initial-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
loop-terminology-rotated-loop.png [LoopTerminology] Rotated Loops images 2020-03-17 01:02:19 +02:00
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 <https://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` <-> `https://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.
`https://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