llvm-project/llvm/docs
Mark Seaborn 6e15ee85d1 Add a note about using "Differential Revision:" in commit messages
I noticed this convention from the commit logs.  It seems like it
would be useful to document it, to encourage other committers to link
back to code reviews in their commits.

Differential Revision: http://llvm-reviews.chandlerc.com/D2678

llvm-svn: 201160
2014-02-11 16:58:03 +00:00
..
CommandGuide Remove link to unexisting llvm-prof docs 2013-12-24 19:58:49 +00:00
HistoricalNotes [typo] An LLVM. 2013-08-16 23:30:19 +00:00
TableGen [docs] TableGen easter egg: Multiline string literals 2014-02-09 02:43:50 +00:00
_static
_templates
_themes/llvm-theme Sphinx CSS: remove negative letter-spacing, it makes some fonts look really 2012-09-30 20:43:24 +00:00
tutorial [OCaml] (PR10016) Add a few missing line in OCamlLangImpl2.rst 2013-11-05 12:14:04 +00:00
AliasAnalysis.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Atomics.rst Small correction to unordered memory code generation of ARM LDRD 2013-06-18 23:07:16 +00:00
BitCodeFormat.rst [ms-cxxabi] Add a new calling convention that swaps 'this' and 'sret' 2014-01-31 17:41:22 +00:00
BranchWeightMetadata.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Bugpoint.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
CMake.rst CMake : optionaly enable LLVM to be compiled with -std=c++11 (default: off) 2013-11-26 10:33:53 +00:00
CMakeLists.txt [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable. 2013-08-28 21:55:26 +00:00
CodeGenerator.rst [ms-cxxabi] Add a new calling convention that swaps 'this' and 'sret' 2014-01-31 17:41:22 +00:00
CodingStandards.rst Revert my commit in r199620 that added sections about namespaces to the 2014-01-20 10:15:32 +00:00
CommandLine.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
CompilerWriterInfo.rst Update the links to the SPARC information. 2013-12-19 20:54:33 +00:00
DebuggingJITedCode.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
DeveloperPolicy.rst Update the developer policy to more clearly spell out the steps for 2014-01-10 00:08:34 +00:00
Dummy.html Add a dummy documentation file to unbreak 'make install'. We need to find how 2012-12-13 13:37:35 +00:00
ExceptionHandling.rst Documentation: use monospaced font for intrinsics' names 2013-01-13 16:07:49 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst Fix documentation on the path to Bitcode reader/writer 2013-06-11 18:09:21 +00:00
Extensions.rst [COFF] Add support for the .secidx directive 2013-12-20 18:15:00 +00:00
FAQ.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
GarbageCollection.rst Remove reference to obsolete arguments. 2013-10-18 23:11:25 +00:00
GetElementPtr.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
GettingStarted.rst Add a note to documentation that Clang + libstdc++ 4.7.2 can not be used to build LLD. 2014-02-04 12:02:13 +00:00
GettingStartedVS.rst Updating the getting started guide for Visual Studio a smidge. 2014-01-23 20:46:44 +00:00
GoldPlugin.rst Update the LTO GoldPlugin documentation 2013-12-02 07:15:33 +00:00
HowToAddABuilder.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
HowToBuildOnARM.rst Adding some info about stability of ARM boards 2013-11-15 08:42:14 +00:00
HowToCrossCompileLLVM.rst [docs] Some typographical fixes. 2013-09-09 19:05:03 +00:00
HowToReleaseLLVM.rst HowToReleaseLLVM: Add information about dot releases 2014-02-04 17:18:20 +00:00
HowToSetUpLLVMStyleRTTI.rst [docs] Discuss a potential bug to be aware of. 2013-03-16 16:58:20 +00:00
HowToSubmitABug.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
HowToUseAttributes.rst Documentation: HowToUseAttributes: formatting (use monospaced font) 2013-02-12 18:26:08 +00:00
HowToUseInstrMappings.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
InAlloca.rst Change inalloca rules to make it only apply to the last parameter 2014-01-16 22:59:24 +00:00
LLVMBuild.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
LLVMBuild.txt
LangRef.rst Lower llvm.expect intrinsic correctly for i1 2014-02-02 22:43:55 +00:00
Lexicon.rst [docs] PR15254: Add "AST" to the lexicon. 2013-02-13 21:17:20 +00:00
LinkTimeOptimization.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
MCJIT-creation.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-dyld-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-engine-builder.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load-object.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-load.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJIT-resolve-relocations.png Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
MCJITDesignAndImplementation.rst Adding a document to describe the MCJIT execution engine implementation. 2013-08-21 22:15:09 +00:00
Makefile docs: Remove incompatibility with Solaris shell 2013-10-15 08:30:07 +00:00
Makefile.sphinx Makefile.sphinx: reST conversion is complete! 2012-12-12 21:35:43 +00:00
MakefileGuide.rst Remove stray '_'. 2013-10-28 21:43:54 +00:00
MarkedUpDisassembly.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
NVPTXUsage.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
Packaging.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
Passes.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Phabricator.rst Add a note about using "Differential Revision:" in commit messages 2014-02-11 16:58:03 +00:00
ProgrammersManual.rst Typos. (Test commit.) 2013-11-14 18:47:23 +00:00
Projects.rst Documentation: remove all mentions of DejaGNU and Tcl 2013-01-18 19:27:43 +00:00
README.txt [docs] Discuss manpage output. 2013-02-27 18:48:42 +00:00
ReleaseNotes.rst Remove support for not using .loc directives. 2014-02-05 18:00:21 +00:00
ReleaseProcess.rst Update Release Process doc 2013-06-12 11:35:33 +00:00
SegmentedStacks.rst docs: Fix long standing linking antipattern. 2013-01-11 02:28:08 +00:00
SourceLevelDebugging.rst Correct word hyphenations 2013-12-05 05:44:44 +00:00
SphinxQuickstartTemplate.rst [docs] Provide pointer for building Sphinx docs. 2013-02-27 18:33:21 +00:00
StackMaps.rst [Stackmaps] Record the stack size of each function that contains a stackmap/patchpoint intrinsic. 2014-01-30 18:58:27 +00:00
SystemLibrary.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
TableGenFundamentals.rst [docs] [tblgen] clarify that code fragments are just string literals 2014-02-09 02:54:26 +00:00
TestSuiteMakefileGuide.rst remove the rest of the "written by" lines in the documentation. It is 2013-01-10 21:24:04 +00:00
TestingGuide.rst Remove mention of old deleted test scripts from testing guide 2014-01-08 16:30:03 +00:00
Vectorizers.rst Update the docs. 2013-08-05 04:27:34 +00:00
WritingAnLLVMBackend.rst Add a RequireStructuredCFG Field to TargetMachine. 2013-12-07 01:49:19 +00:00
WritingAnLLVMPass.rst fix RST reference in Writing an LLVM Pass 2013-10-30 17:09:32 +00:00
YamlIO.rst Fix documentation typos 2013-12-20 00:33:39 +00:00
conf.py Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
doxygen.cfg.in Fix documentation typos 2013-12-20 00:33:39 +00:00
doxygen.css
doxygen.footer Update the copyright credits -- Happy new year 2014! 2014-01-01 08:27:31 +00:00
doxygen.header
doxygen.intro
gcc-loops.png Update the gcc-loops benchmark 2013-01-20 07:01:04 +00:00
index.rst LangRef documentation for the stackmap and patchpoint intrinsics. 2013-12-24 02:57:25 +00:00
linpack-pc.png Update the linpack benchmark with different array sizes. 2013-01-20 06:52:47 +00:00
make.bat
re_format.7
yaml2obj.rst Fix common typos in the docs. 2013-10-29 17:53:27 +00:00

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 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`.