Commit Graph

4525 Commits

Author SHA1 Message Date
Jan Wen Voung
0919f22dec Fix a typo in bitcode docs, from 165814.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165944 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-15 16:47:58 +00:00
Dmitri Gribenko
549ea3a540 Documentation: Lexicon.rst: add "BB Vectorization" and "TBAA".
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165879 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-13 17:34:49 +00:00
Jan Wen Voung
780c798222 Add bitcode instruction encoding documentation for module version
0 and 1.  Followup to 165739.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165814 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-12 18:13:17 +00:00
Sean Silva
6df933e371 docs: Update example to conform to coding standards.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165782 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-12 01:55:51 +00:00
Sean Silva
b92dfe0aad docs: Minor clean up of Phabricator documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165779 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-12 01:21:24 +00:00
Sean Silva
5d499c2de4 docs: Add SphinxQuickstartTemplate.rst.
The intent of this document is to be the go-to document for anybody who
wants to write new documentation, but isn't familiar with Sphinx.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165775 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-12 00:53:48 +00:00
Sean Silva
4057399882 docs: Improve HowToSetUpLLVMStyleRTTI.
* Fix confusing explanation regarding abstract classes.

* Clarify auto-upcasting and why `Shape` doesn't need a `classof()`.

* Add section `Rules of Thumb` with some quick summary tips.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165768 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-11 23:30:52 +00:00
Sean Silva
8a6538cd61 docs: Update HowToSetUpLLVMStyleRTTI.
Recent changes to isa<>/dyn_cast<> have made unnecessary those classof()
of the form:

    static bool classof(const Foo *) { return true; }

Accordingly, remove mention of such classof() from the documentation.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165766 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-11 23:30:41 +00:00
Manuel Klimek
81eb88f7d2 Adds Phabricator documentation. This is a first step that answers many questions we have seen.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165736 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-11 19:40:46 +00:00
NAKAMURA Takumi
cea9264f6b GettingStarted.rst: s/&amp;/&/g
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165690 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-11 01:10:37 +00:00
NAKAMURA Takumi
df60867d9c GettingStarted.rst: Fix the label to DeveloperPolicy.html.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165689 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-11 01:10:27 +00:00
Sean Silva
36a11b39d8 docs: Propagate fix from r165632 to other docs.
There are only two other instances of using `.. code::` instead of
`..  code-block::`.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165633 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-10 17:21:39 +00:00
Sean Silva
a8759dde00 docs: Attempt to fix PR14053.
Hypothesis 1: use of `.. code::` directive instead of `.. code-block::`
is causing Sphinx to discard the block. On my machine, `.. code::`
renders fine. However, I don't think that `..  code::` is actually a
legit Sphinx directive. I believe that on my machine Sphinx is falling
back to just displaying it monospace with no syntax, whereas llvm.org's
Sphinx is just discarding it.

This is truly "remote debugging" since I can't reproduce this on my
machine. It would be helpful to be able to see the llvm.org Sphinx
build logs; if that's possible please let me know.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165632 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-10 17:07:23 +00:00
Eric Christopher
9f11bf52b4 Fix typo in docs.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165464 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-08 23:54:10 +00:00
Micah Villmow
791cfc211a Move TargetData to DataLayout.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165403 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-08 16:39:34 +00:00
Sean Silva
59ccfb004c Silence Sphinx warnings.
Found the fix on this page:
http://permalink.gmane.org/gmane.comp.python.sphinx.devel/112

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165380 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-07 18:49:28 +00:00
Bill Wendling
f93c55a392 Sphinxify the GettinStarted documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165372 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-07 07:10:13 +00:00
Bill Wendling
bef3ef9975 Sphinxify the ExtendingLLVM documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165371 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-07 04:56:08 +00:00
Bill Wendling
53960a682e Sphinxify the compiler writer info documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165369 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-07 04:34:10 +00:00
Rafael Espindola
af63f0b6dc Document MapVector.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165366 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-07 00:56:09 +00:00
Dmitri Gribenko
07d1c21bc6 HowToSetUpLLVMStyleRTTI.rst: remove unneeded semicolons in code examples.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165335 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-05 20:52:13 +00:00
Dmitri Gribenko
038c43be0b GoldPlugin.rst: minor typesetting fixes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165334 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-05 20:50:05 +00:00
Sean Silva
36be1aeac7 docs: Add HowToSetUpLLVMStyleRTTI.rst.
This document describes how to set up LLVM-style RTTI for a class
hierarchy. Surprisingly, this was not previously documented.

Also, link it into ProgrammersManual.html.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165293 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-05 03:32:01 +00:00
Duncan Sands
ffcf6dffee The alignment of an sret parameter is known: it must be at least the
alignment of the return type.  Teach the optimizers this.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165226 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-04 13:36:31 +00:00
Sean Silva
96098782d1 docs: Fix typo on front page
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165200 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-04 04:41:27 +00:00
Sean Silva
34c6b7e925 docs: Sphinxify GoldPlugin document.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@165198 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-04 03:56:23 +00:00
Michael J. Spencer
06d9981d27 [Docs] Update File Headers section to cover doxygen style file level docs.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164964 91177308-0d34-0410-b5e6-96231b3b80d8
2012-10-01 19:59:21 +00:00
Dmitri Gribenko
8bd5e35978 RST docs: convert HTML escapes to plain text in code examples.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164922 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-30 20:51:02 +00:00
Dmitri Gribenko
58c7ea7361 Sphinx CSS: remove negative letter-spacing, it makes some fonts look really
bad.  Fonts already have appropriate tracking built-in.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164921 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-30 20:43:24 +00:00
Jakub Staszak
bfa43c0422 Fix &amp;&amp; to && in Coding Standards.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164920 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-30 20:42:13 +00:00
Sean Silva
74a19f0729 docs: dedent list on index.rst
In reStructuredText, indented blocks denote block quotes [1]. This list
is not a block quote.

[1]. http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164847 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-28 21:18:37 +00:00
Andrew Kaylor
770b97b995 Removing dependency on third party library for Intel JIT event support.
Patch committed on behalf of Kirill Uhanov

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164831 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-28 17:35:20 +00:00
Micah Villmow
6f6ea93c92 Fix more crlf issues.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164805 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-27 22:14:10 +00:00
Micah Villmow
593c0b08e6 Fix CRLF issues.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164782 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-27 17:51:02 +00:00
Micah Villmow
7149ef0176 Patch for HowToBuildOnARM documentation from Wei-Ren Chen.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164776 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-27 15:05:49 +00:00
Sean Silva
87ed553019 docs: Sphinxify HowToSubmitABug
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164630 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-25 20:52:04 +00:00
Sean Silva
fdb6ec34cd docs: Fix long-standing typo in yaml2obj.rst.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164407 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 19:48:16 +00:00
Dan Gohman
ee9f726749 Say "bytes" instead of "address units", since that's what the
rest of LangRef uses.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164402 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 18:41:30 +00:00
Dan Gohman
273a92eb0a Document the new !tbaa.struct metadata.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164398 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 18:21:48 +00:00
David Blaikie
b890e9fc66 Add missing 'to' and rephrase an explanation of GCC's assumptions.
Wordsmithing by Matt Beaumont-Gay in response to r164389.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164395 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 18:03:02 +00:00
David Blaikie
67bf429a6a Document "do not use defaults in covered switch-over-enum" coding standard.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164389 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 17:47:36 +00:00
Sean Silva
258aeb5762 docs: Fix Sphinx warning over Atomics.rst.
Atomics.rst was not linked into the toctree.

Docs now build warning-free!

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164356 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 02:46:32 +00:00
Sean Silva
5cc1e23247 docs: Fix Sphinx warning over yaml2obj.rst.
yaml2obj.rst was not included in the toctree

Input from Michael Spencer.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164355 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-21 02:46:30 +00:00
Andrew Trick
e9f59888d4 Fix function names in coding style examples
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164311 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-20 17:02:04 +00:00
Sean Silva
f5b69f630c Fix Sphinx warnings.
Toctree was not being interlinked properly.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164282 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-20 03:20:53 +00:00
Sean Silva
1141b5227e Sphinxify DebuggingJITedCode
LGTM by Michael Spencer

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164280 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-20 03:05:26 +00:00
Andrew Trick
331e8fb760 Fix static function names in CodingStandards examples.
Try not to violate conventions immediately before explaining them.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164278 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-20 02:01:06 +00:00
Sean Silva
a177a51108 Test commit
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164174 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-18 22:21:43 +00:00
Dmitri Gribenko
e3f1459b7d Coding standards: fix typo: '= deleted' -> '= delete'.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164126 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-18 14:00:58 +00:00
Craig Topper
88b5a2bf34 Add LLVM_DELETED_FUNCTION to coding standards.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164101 91177308-0d34-0410-b5e6-96231b3b80d8
2012-09-18 04:43:40 +00:00