1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-24 19:52:54 +01:00
llvm-mirror/docs
Renato Golin 6533f82835 Adding commit msg guidelines to dev policy
After much bike shed discussions, we seem to agree to a few loose
but relevant guidelines on how to prepare a commit message. It also
points the attribution section to the new commit messages section
to deduplicate information.

llvm-svn: 232334
2015-03-15 21:15:48 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide docs: Fix a typo in my previous commit 2015-03-12 04:43:01 +00:00
Frontend Add a few more performance tips 2015-03-05 05:55:55 +00:00
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
BitSets.rst LowerBitSets: Introduce global layout builder. 2015-02-24 23:17:02 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst
Bugpoint.rst
BuildingLLVMWithAutotools.rst A few minor updates based on feedback from Justin and a few things I thought were missing. 2015-03-14 21:20:32 +00:00
CMake.rst Help: Document how to build and install with CMake. 2015-02-13 16:15:32 +00:00
CMakeLists.txt
CodeGenerator.rst Fix grammar in documentation. 2015-02-19 18:46:25 +00:00
CodingStandards.rst CodingStyle: Allow delegating ctors 2015-03-06 13:46:50 +00:00
CommandLine.rst
CompilerWriterInfo.rst
conf.py
CoverageMappingFormat.rst
DebuggingJITedCode.rst
DeveloperPolicy.rst Adding commit msg guidelines to dev policy 2015-03-15 21:15:48 +00:00
doxygen.cfg.in [docs] Update the doxygen configuration file. 2015-03-12 17:26:27 +00:00
doxygen.intro
Dummy.html
ExceptionHandling.rst Make llvm.eh.actions an intrinsic and add docs for it 2015-03-12 01:45:37 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst
FAQ.rst
GarbageCollection.rst [GC Docs] Update LangRef to link to Statepoint docs 2015-02-25 23:45:20 +00:00
gcc-loops.png
GetElementPtr.rst Update LangRef for getelementptr explicit type changes 2015-03-04 22:02:58 +00:00
GettingStarted.rst A few minor updates based on feedback from Justin and a few things I thought were missing. 2015-03-14 21:20:32 +00:00
GettingStartedVS.rst Update the docs to require at least MSVC 2013. 2015-02-15 19:34:17 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst
index.rst Updating GettingStarted documentation to reference CMake as the preferred way to build LLVM. 2015-03-13 01:58:14 +00:00
LangRef.rst Update LangRef now that a DataLayout is mandatory. 2015-03-14 22:04:06 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile [docs] Update the doxygen configuration file. 2015-03-12 17:26:27 +00:00
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
MergeFunctions.rst Inspired by r231891, use gender neutral pronouns in the places I've 2015-03-11 00:15:44 +00:00
NVPTXUsage.rst
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst docs: Mention that assertions must be enabled to use the -stats flag 2015-02-21 20:53:36 +00:00
Projects.rst
R600Usage.rst
re_format.7
README.txt
ReleaseNotes.rst Add a link to the new PerformanceTips docs from the 3.7 release notes 2015-03-05 05:11:05 +00:00
ReleaseProcess.rst
SegmentedStacks.rst
SourceLevelDebugging.rst
SphinxQuickstartTemplate.rst
StackMaps.rst
Statepoints.rst [GC docs] Add example IR, assembly, and stackmaps to Statepoint documentation 2015-02-26 01:18:21 +00:00
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