llvm-6502/docs
Saleem Abdulrasool ddbde80aae ARM: support stack probe emission for Windows on ARM
This introduces the stack lowering emission of the stack probe function for
Windows on ARM. The stack on Windows on ARM is a dynamically paged stack where
any page allocation which crosses a page boundary of the following guard page
will cause a page fault. This page fault must be handled by the kernel to
ensure that the page is faulted in. If this does not occur and a write access
any memory beyond that, the page fault will go unserviced, resulting in an
abnormal program termination.

The watermark for the stack probe appears to be at 4080 bytes (for
accommodating the stack guard canaries and stack alignment) when SSP is
enabled.  Otherwise, the stack probe is emitted on the page size boundary of
4096 bytes.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@207615 91177308-0d34-0410-b5e6-96231b3b80d8
2014-04-30 07:05:07 +00:00
..
_static
_templates
_themes/llvm-theme
CommandGuide [docs] Fix some links 2014-04-07 22:46:40 +00:00
HistoricalNotes
TableGen [docs] VCS contains a record of authorship 2014-04-08 21:12:56 +00:00
tutorial
AliasAnalysis.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
Atomics.rst
BitCodeFormat.rst Remove the linker_private and linker_private_weak linkages. 2014-03-13 23:18:37 +00:00
BlockFrequencyTerminology.rst blockfreq: Document BlockFrequencyInfo terminology 2014-04-11 23:21:07 +00:00
BranchWeightMetadata.rst blockfreq: Document BlockFrequencyInfo terminology 2014-04-11 23:21:07 +00:00
Bugpoint.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
CMake.rst Document recently added sphinx documentation options in 2014-04-29 16:13:27 +00:00
CMakeLists.txt Added Sphinx documentation generation to CMake build system. 2014-04-18 21:45:25 +00:00
CodeGenerator.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
CodingStandards.rst C++11: Compatibility with (C++03 => MSVC) 2014-04-17 18:02:36 +00:00
CommandLine.rst
CompilerWriterInfo.rst Fix some doc and comment typos 2014-04-09 14:47:27 +00:00
conf.py
DebuggingJITedCode.rst
DeveloperPolicy.rst
doxygen.cfg.in [docs] Teach CMake docs build how to generate Qt Creator help/documentation files. 2014-03-07 19:19:28 +00:00
doxygen.css
doxygen.footer
doxygen.header
doxygen.intro
Dummy.html
ExceptionHandling.rst Exception handling docs: Clarify how the llvm.eh.* intrinsics are used 2014-03-28 17:08:57 +00:00
ExtendedIntegerResults.txt
ExtendingLLVM.rst
Extensions.rst ARM: support stack probe emission for Windows on ARM 2014-04-30 07:05:07 +00:00
FAQ.rst remove an old entry whose link is broken anyway 2014-03-02 06:37:03 +00:00
GarbageCollection.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
gcc-loops.png
GetElementPtr.rst
GettingStarted.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
GettingStartedVS.rst [docs] Fix up some links to the preferred style. 2014-04-08 21:06:22 +00:00
GoldPlugin.rst
HowToAddABuilder.rst
HowToBuildOnARM.rst
HowToCrossCompileLLVM.rst
HowToReleaseLLVM.rst
HowToSetUpLLVMStyleRTTI.rst [C++11] Replace LLVM-style type traits with C++11 standard ones. 2014-03-07 14:42:25 +00:00
HowToSubmitABug.rst
HowToUseAttributes.rst
HowToUseInstrMappings.rst
InAlloca.rst inalloca: *Really* fix the docs 2014-03-27 01:38:48 +00:00
index.rst blockfreq: Document BlockFrequencyInfo terminology 2014-04-11 23:21:07 +00:00
LangRef.rst Add 'musttail' marker to call instructions 2014-04-24 20:14:34 +00:00
Lexicon.rst
LinkTimeOptimization.rst
linpack-pc.png
LLVMBuild.rst [docs] Fix some links 2014-04-07 22:46:40 +00:00
LLVMBuild.txt
make.bat
Makefile
Makefile.sphinx
MakefileGuide.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
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
NVPTXUsage.rst
Packaging.rst
Passes.rst Remove -simplify-libcalls pass form Passes documentation 2014-04-18 21:19:06 +00:00
Phabricator.rst Make docs point to new domain. 2014-04-07 10:21:33 +00:00
ProgrammersManual.rst "Mac OS/X" -> "Mac OS X" spelling fixes for llvm. 2014-03-07 18:08:54 +00:00
Projects.rst Remove projects/sample. 2014-03-12 22:40:22 +00:00
re_format.7
README.txt [docs] Add a note to docs/README.txt 2014-04-22 21:47:53 +00:00
ReleaseNotes.rst Update release notes with EHABI current behaviour 2014-03-24 11:02:38 +00:00
ReleaseProcess.rst
SegmentedStacks.rst Move the segmented stack switch to a function attribute 2014-04-10 22:58:43 +00:00
SourceLevelDebugging.rst Switch the type field in DIVariable and DIGlobalVariable over to DITypeRefs. 2014-03-18 02:34:58 +00:00
SphinxQuickstartTemplate.rst
StackMaps.rst Stack map docs. Remove some stray markup. 2014-04-03 07:08:21 +00:00
SystemLibrary.rst
TableGenFundamentals.rst Recover TableGen/LangRef, make it official 2014-04-01 09:51:49 +00:00
TestingGuide.rst
TestSuiteMakefileGuide.rst
Vectorizers.rst Fix whitespace in vectorizer example 2014-03-12 23:58:07 +00:00
WritingAnLLVMBackend.rst [docs] Fix some links 2014-04-07 22:46:40 +00:00
WritingAnLLVMPass.rst
yaml2obj.rst Object: rename ARMV7 to ARMNT 2014-03-11 03:08:37 +00:00
YamlIO.rst YAMLIO: Allow scalars to dictate quotation rules 2014-04-10 07:37:33 +00:00

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