llvm-mirror/docs
Victor Leschuk 9cc7a42fca DebugInfo: support for DWARFv5 DW_AT_alignment attribute
* Assume that clang passes non-zero alignment value to DIBuilder
only in case when it was forced by C++11 'alignas', C11 '_Alignas'
or compiler attribute '__attribute__((aligned (N)))'.

* Emit DW_AT_alignment if alignment is specified for type/object.

Differential Revision: https://reviews.llvm.org/D24425

llvm-svn: 285189
2016-10-26 11:59:03 +00:00
..
_ocamldoc
_static Fix some typos in the doc 2016-08-28 20:29:18 +00:00
_templates
_themes/llvm-theme
CommandGuide [llvm-cov] Add support for loading coverage from multiple objects 2016-10-25 17:40:55 +00:00
Frontend
HistoricalNotes
Proposals [doc] use double `` to prevent html output of merging double dash 2016-10-17 19:23:19 +00:00
TableGen [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
tutorial [Docs] Fix a broken link in the Kaleidoscope tutorial. 2016-09-13 06:31:37 +00:00
AdvancedBuilds.rst
AliasAnalysis.rst [Docs] Add initial MemorySSA documentation. 2016-08-17 00:17:29 +00:00
AMDGPUUsage.rst AMDGPU: Improve documentation. 2016-09-20 09:04:51 +00:00
ARM-BE-bitcastfail.png
ARM-BE-bitcastsuccess.png
ARM-BE-ld1.png
ARM-BE-ldr.png
Atomics.rst
BigEndianNEON.rst
BitCodeFormat.rst [docs] Update some obsolete information in BitCodeFormat docs. 2016-10-14 16:23:09 +00:00
BlockFrequencyTerminology.rst
BranchWeightMetadata.rst This code block breaks the docs build (http://lab.llvm.org:8011/builders/llvm-sphinx-docs/builds/11925/steps/docs-llvm-html/logs/stdio). Setting the code highlighting to none instead of llvm. 2016-07-19 23:50:11 +00:00
Bugpoint.rst
CMake.rst [cmake] Support overriding remaining HTML doc install directories 2016-09-27 19:52:29 +00:00
CMakeLists.txt [cmake] Support overriding remaining HTML doc install directories 2016-09-27 19:52:29 +00:00
CMakePrimer.rst [docs] fix cmake code-block warning 2016-07-20 09:47:09 +00:00
CodeGenerator.rst [Support/ELF/AMDGPU] Add 32-bit lo/hi got and pc relative relocations 2016-10-14 04:03:49 +00:00
CodeOfConduct.rst
CodingStandards.rst Update docs to reflect new minimum MSVC version requirement 2016-10-19 23:04:41 +00:00
CommandLine.rst Update documentation after r283671 ("Turn cl::values() (for enum) from a vararg function to using C++ variadic template") 2016-10-10 17:13:14 +00:00
CompileCudaWithLLVM.rst [CUDA] [doc] Note that you can use std::min/max from device code with C++14. 2016-09-16 04:14:02 +00:00
CompilerWriterInfo.rst AMDGPU: Improve documentation. 2016-09-20 09:04:51 +00:00
conf.py Fix some typos in the doc 2016-08-28 20:29:18 +00:00
Coroutines.rst Changing a code block to text because Sphinx does not like it on the builder (http://lab.llvm.org:8011/builders/llvm-sphinx-docs/builds/12517/steps/docs-llvm-html/logs/stdio) 2016-08-31 14:37:20 +00:00
CoverageMappingFormat.rst Removes a warning about duplicate label named _strings from CommandLine.rst. 2016-07-23 18:52:21 +00:00
DebuggingJITedCode.rst
DeveloperPolicy.rst wordsmith the "new targets" section a bit. 2016-08-17 22:17:03 +00:00
doxygen-mainpage.dox
doxygen.cfg.in Fix some typos in the doc 2016-08-28 20:29:18 +00:00
Dummy.html
ExceptionHandling.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst Document our extension to the COFF .section directive flags 2016-09-15 15:11:49 +00:00
FAQ.rst fix some typos in the doc 2016-07-28 09:28:58 +00:00
FaultMaps.rst
GarbageCollection.rst Tidy up example of getting the pointer size. 2016-10-14 05:45:46 +00:00
gcc-loops.png
GetElementPtr.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
GettingStarted.rst Update docs to reflect new minimum MSVC version requirement 2016-10-19 23:04:41 +00:00
GettingStartedVS.rst Update docs to reflect new minimum MSVC version requirement 2016-10-19 23:04:41 +00:00
GoldPlugin.rst
HowToAddABuilder.rst [docs] Fix a broken URL in 'HowToAddABuilder' 2016-09-29 13:29:49 +00:00
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst Adding RELEASE_TESTERS.TXT 2016-07-21 16:46:44 +00:00
HowToSetUpLLVMStyleRTTI.rst
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
InAlloca.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
index.rst Moving to GitHub - Unified Proposal 2016-10-12 23:02:02 +00:00
LangRef.rst fix title underline length 2016-10-12 23:10:02 +00:00
Lexicon.rst [docs] Add PR to Lexicon 2016-10-06 16:39:22 +00:00
LibFuzzer.rst [libFuzzer] refresh docs 2016-10-26 01:55:17 +00:00
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst
LLVMBuild.txt
make.bat
Makefile.sphinx
MarkedUpDisassembly.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00: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
MemorySSA.rst Fix some typos in the doc 2016-08-28 20:29:18 +00:00
MergeFunctions.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
MIRLangRef.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
NVPTXUsage.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
OptBisect.rst Adding document describing the use of the -opt-bisect-limit option. 2016-08-26 23:11:48 +00:00
Packaging.rst
Passes.rst
Phabricator.rst
ProgrammersManual.rst [docs] Avoid repetition of 'considerable' in Error docs. 2016-10-25 23:08:32 +00:00
Projects.rst
re_format.7
README.txt
ReleaseNotes.rst ReleaseNotes: mention new compiler requirements 2016-10-24 17:29:52 +00:00
ReleaseProcess.rst
ReportingGuide.rst
ScudoHardenedAllocator.rst [scudo] Documentation update for Scudo, from https://reviews.llvm.org/D23332 2016-08-09 23:57:04 +00:00
SegmentedStacks.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
SourceLevelDebugging.rst DebugInfo: support for DWARFv5 DW_AT_alignment attribute 2016-10-26 11:59:03 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst [Stackmap] Added callsite counts to emitted function information. 2016-09-14 20:22:03 +00:00
Statepoints.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
SystemLibrary.rst
TableGenFundamentals.rst
TestingGuide.rst
TestSuiteMakefileGuide.rst
TypeMetadata.rst
Vectorizers.rst
WritingAnLLVMBackend.rst Move the global variables representing each Target behind accessor function 2016-10-09 23:00:34 +00:00
WritingAnLLVMPass.rst [docs] Make WritingAnLLVMPass.rst up-to-date with current state of things 2016-09-27 12:07:21 +00:00
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 <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