Commit Graph

4524 Commits

Author SHA1 Message Date
Dmitri Gribenko 2378c5e230 Documentation: Lexicon.rst: add "BB Vectorization" and "TBAA".
llvm-svn: 165879
2012-10-13 17:34:49 +00:00
Jan Wen Voung 77c6c85e84 Add bitcode instruction encoding documentation for module version
0 and 1.  Followup to 165739.

llvm-svn: 165814
2012-10-12 18:13:17 +00:00
Sean Silva 3b942abef3 docs: Update example to conform to coding standards.
llvm-svn: 165782
2012-10-12 01:55:51 +00:00
Sean Silva b39f47b067 docs: Minor clean up of Phabricator documentation.
llvm-svn: 165779
2012-10-12 01:21:24 +00:00
Sean Silva d91ff4c942 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.

llvm-svn: 165775
2012-10-12 00:53:48 +00:00
Sean Silva d7802ad8a5 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.

llvm-svn: 165768
2012-10-11 23:30:52 +00:00
Sean Silva d73b2818a1 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.

llvm-svn: 165766
2012-10-11 23:30:41 +00:00
Manuel Klimek 8398126bdd Adds Phabricator documentation. This is a first step that answers many questions we have seen.
llvm-svn: 165736
2012-10-11 19:40:46 +00:00
NAKAMURA Takumi 66304d5411 GettingStarted.rst: s/&amp;/&/g
llvm-svn: 165690
2012-10-11 01:10:37 +00:00
NAKAMURA Takumi 4b71c205b9 GettingStarted.rst: Fix the label to DeveloperPolicy.html.
llvm-svn: 165689
2012-10-11 01:10:27 +00:00
Sean Silva 529ecebe4c docs: Propagate fix from r165632 to other docs.
There are only two other instances of using `.. code::` instead of
`..  code-block::`.

llvm-svn: 165633
2012-10-10 17:21:39 +00:00
Sean Silva 9ce5c06626 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.

llvm-svn: 165632
2012-10-10 17:07:23 +00:00
Eric Christopher b0d9dec1ff Fix typo in docs.
llvm-svn: 165464
2012-10-08 23:54:10 +00:00
Micah Villmow 9cfc13d46c Move TargetData to DataLayout.
llvm-svn: 165403
2012-10-08 16:39:34 +00:00
Sean Silva a4fe992756 Silence Sphinx warnings.
Found the fix on this page:
http://permalink.gmane.org/gmane.comp.python.sphinx.devel/112

llvm-svn: 165380
2012-10-07 18:49:28 +00:00
Bill Wendling 954e430e9b Sphinxify the GettinStarted documentation.
llvm-svn: 165372
2012-10-07 07:10:13 +00:00
Bill Wendling c3b3463fcf Sphinxify the ExtendingLLVM documentation.
llvm-svn: 165371
2012-10-07 04:56:08 +00:00
Bill Wendling 668043f0db Sphinxify the compiler writer info documentation.
llvm-svn: 165369
2012-10-07 04:34:10 +00:00
Rafael Espindola ec2a51c154 Document MapVector.
llvm-svn: 165366
2012-10-07 00:56:09 +00:00
Dmitri Gribenko 8b76113f05 HowToSetUpLLVMStyleRTTI.rst: remove unneeded semicolons in code examples.
llvm-svn: 165335
2012-10-05 20:52:13 +00:00
Dmitri Gribenko 9dd4687fcc GoldPlugin.rst: minor typesetting fixes.
llvm-svn: 165334
2012-10-05 20:50:05 +00:00
Sean Silva 5ce54c2eb9 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.

llvm-svn: 165293
2012-10-05 03:32:01 +00:00
Duncan Sands 271ea6cdc5 The alignment of an sret parameter is known: it must be at least the
alignment of the return type.  Teach the optimizers this.

llvm-svn: 165226
2012-10-04 13:36:31 +00:00
Sean Silva 03254cae95 docs: Fix typo on front page
llvm-svn: 165200
2012-10-04 04:41:27 +00:00
Sean Silva fc6de0f2cb docs: Sphinxify GoldPlugin document.
llvm-svn: 165198
2012-10-04 03:56:23 +00:00
Michael J. Spencer 99a241fa2c [Docs] Update File Headers section to cover doxygen style file level docs.
llvm-svn: 164964
2012-10-01 19:59:21 +00:00
Dmitri Gribenko 37f92c74d2 RST docs: convert HTML escapes to plain text in code examples.
llvm-svn: 164922
2012-09-30 20:51:02 +00:00
Dmitri Gribenko 0fd5ce068e Sphinx CSS: remove negative letter-spacing, it makes some fonts look really
bad.  Fonts already have appropriate tracking built-in.

llvm-svn: 164921
2012-09-30 20:43:24 +00:00
Jakub Staszak 2e747e3596 Fix &amp;&amp; to && in Coding Standards.
llvm-svn: 164920
2012-09-30 20:42:13 +00:00
Sean Silva 6f876c1028 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

llvm-svn: 164847
2012-09-28 21:18:37 +00:00
Andrew Kaylor 5808c7d828 Removing dependency on third party library for Intel JIT event support.
Patch committed on behalf of Kirill Uhanov

llvm-svn: 164831
2012-09-28 17:35:20 +00:00
Micah Villmow daa1c74da8 Fix more crlf issues.
llvm-svn: 164805
2012-09-27 22:14:10 +00:00
Micah Villmow eb9c0d0ed5 Fix CRLF issues.
llvm-svn: 164782
2012-09-27 17:51:02 +00:00
Micah Villmow 7345a35777 Patch for HowToBuildOnARM documentation from Wei-Ren Chen.
llvm-svn: 164776
2012-09-27 15:05:49 +00:00
Sean Silva b0a1edce8c docs: Sphinxify HowToSubmitABug
llvm-svn: 164630
2012-09-25 20:52:04 +00:00
Sean Silva 747c639c27 docs: Fix long-standing typo in yaml2obj.rst.
llvm-svn: 164407
2012-09-21 19:48:16 +00:00
Dan Gohman 3397bb248f Say "bytes" instead of "address units", since that's what the
rest of LangRef uses.

llvm-svn: 164402
2012-09-21 18:41:30 +00:00
Dan Gohman e36188f30e Document the new !tbaa.struct metadata.
llvm-svn: 164398
2012-09-21 18:21:48 +00:00
David Blaikie f787f171a3 Add missing 'to' and rephrase an explanation of GCC's assumptions.
Wordsmithing by Matt Beaumont-Gay in response to r164389.

llvm-svn: 164395
2012-09-21 18:03:02 +00:00
David Blaikie 00bec9a4ad Document "do not use defaults in covered switch-over-enum" coding standard.
llvm-svn: 164389
2012-09-21 17:47:36 +00:00
Sean Silva 835ef201ac docs: Fix Sphinx warning over Atomics.rst.
Atomics.rst was not linked into the toctree.

Docs now build warning-free!

llvm-svn: 164356
2012-09-21 02:46:32 +00:00
Sean Silva 9f0311deee docs: Fix Sphinx warning over yaml2obj.rst.
yaml2obj.rst was not included in the toctree

Input from Michael Spencer.

llvm-svn: 164355
2012-09-21 02:46:30 +00:00
Andrew Trick e6af4b9a35 Fix function names in coding style examples
llvm-svn: 164311
2012-09-20 17:02:04 +00:00
Sean Silva 98f84c998f Fix Sphinx warnings.
Toctree was not being interlinked properly.

llvm-svn: 164282
2012-09-20 03:20:53 +00:00
Sean Silva 51fc86ddfe Sphinxify DebuggingJITedCode
LGTM by Michael Spencer

llvm-svn: 164280
2012-09-20 03:05:26 +00:00
Andrew Trick fc9420c006 Fix static function names in CodingStandards examples.
Try not to violate conventions immediately before explaining them.

llvm-svn: 164278
2012-09-20 02:01:06 +00:00
Sean Silva c99b54d095 Test commit
llvm-svn: 164174
2012-09-18 22:21:43 +00:00
Dmitri Gribenko be88f563bf Coding standards: fix typo: '= deleted' -> '= delete'.
llvm-svn: 164126
2012-09-18 14:00:58 +00:00
Craig Topper 1740e05c31 Add LLVM_DELETED_FUNCTION to coding standards.
llvm-svn: 164101
2012-09-18 04:43:40 +00:00
Galina Kistanova 8201936f60 Patch by Sean Silva!
The patch converts the "How to add a builder" document over to reStructuredText..

llvm-svn: 163860
2012-09-13 23:51:08 +00:00