llvm-project/llvm/docs
Reid Kleckner 6130a2df5c Update docs to reflect new minimum MSVC version requirement
Mailing list discussion about this:
http://lists.llvm.org/pipermail/llvm-dev/2016-September/104631.html

Code changes to simplify the ifdefs will come next, and can be reverted
without affecting the policy if someone needs it.

llvm-svn: 284660
2016-10-19 23:04:41 +00:00
..
CommandGuide [llvm-cov] Add some documentation for the -tab-size option 2016-08-04 18:00:42 +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
_ocamldoc
_static Fix some typos in the doc 2016-08-28 20:29:18 +00:00
_templates
_themes/llvm-theme
tutorial [Docs] Fix a broken link in the Kaleidoscope tutorial. 2016-09-13 06:31:37 +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
AdvancedBuilds.rst Fixing autocorrect changing cmake->make 2016-03-18 22:11:51 +00:00
AliasAnalysis.rst [Docs] Add initial MemorySSA documentation. 2016-08-17 00:17:29 +00:00
Atomics.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
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 [Conduct] Refine what "rare cases" means wrt violations outside our spaces. 2016-07-06 19:32:41 +00:00
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
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
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
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 [docs] Remove references to autotools build. 2016-01-30 01:10:15 +00:00
HowToAddABuilder.rst [docs] Fix a broken URL in 'HowToAddABuilder' 2016-09-29 13:29:49 +00:00
HowToBuildOnARM.rst [Docs] Change ARM build info to CMake 2015-11-06 18:39:34 +00:00
HowToCrossCompileLLVM.rst [docs] Fix unexpected indentation in HowToCrossCompileLLVM.rst 2016-05-10 14:02:46 +00:00
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
LLVMBuild.rst Fixing the documentation builds 2016-01-26 22:53:12 +00:00
LLVMBuild.txt
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] sancov documentation update 2016-09-30 21:07:04 +00:00
LinkTimeOptimization.rst Fix LTO document 2016-07-08 00:28:29 +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 Fix several accidental DOS line endings in source files 2016-01-03 17:22:03 +00:00
MIRLangRef.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
Makefile.sphinx Bring back Makefile.sphinx 2016-03-23 00:30:57 +00:00
MarkedUpDisassembly.rst [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +00:00
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
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 Remove the ScalarReplAggregates pass 2016-06-15 00:19:09 +00:00
Phabricator.rst [docs] Improve the documentation on committing code reviewed on 2016-01-14 13:39:29 +00:00
ProgrammersManual.rst Fixed a typo (LLVM/Support/CFG.h -> LLVM/IR/CFG.h) 2016-09-02 11:13:35 +00:00
Projects.rst
README.txt [docs] Update the docs to describe how to build the docs with cmake 2016-02-07 15:42:12 +00:00
ReleaseNotes.rst Support: Drop LLVM_ATTRIBUTE_UNUSED_RESULT 2016-10-17 07:37:11 +00:00
ReleaseProcess.rst [OPENMP] Make -fopenmp to turn on OpenMP support by default. 2015-12-10 05:45:58 +00:00
ReportingGuide.rst fix some various typos in the doc 2016-07-02 19:28:40 +00:00
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 [docs] Fixing Sphinx warnings to unclog the buildbot 2016-07-20 12:16:38 +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
TestSuiteMakefileGuide.rst Fix the docs I broke 2016-03-11 23:31:02 +00:00
TestingGuide.rst Review fixes to lit documentation 2016-07-12 20:59:17 +00:00
TypeMetadata.rst IR: New representation for CFI and virtual call optimization pass metadata. 2016-06-24 21:21:32 +00:00
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
YamlIO.rst [docs] Fix typo in YamlIO.rst 2016-02-04 20:42:43 +00:00
conf.py Fix some typos in the doc 2016-08-28 20:29:18 +00:00
doxygen-mainpage.dox [docs] Updated docs to work with Doxygen 1.8.11 2016-03-06 03:50:08 +00:00
doxygen.cfg.in Fix some typos in the doc 2016-08-28 20:29:18 +00:00
gcc-loops.png
index.rst Moving to GitHub - Unified Proposal 2016-10-12 23:02:02 +00:00
linpack-pc.png
make.bat
re_format.7
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 <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