Commit Graph

4774 Commits

Author SHA1 Message Date
Sean Silva 543fd7f8be TableGen/LangRef: discuss specific C-like escapes
Suggested by Joel Jones.

llvm-svn: 171941
2013-01-09 02:20:30 +00:00
Sean Silva dce94d3bd2 docs: Fix mention of DefmID to MultiClassID.
llvm-svn: 171940
2013-01-09 02:20:24 +00:00
Sean Silva c95fe2804d docs: Bring TableGen syntax a bit closer to reality.
It's not just def's but actually a limited subset of Object's that are
allowed inside a multiclass.

Spotted by Joel Jones.

llvm-svn: 171935
2013-01-09 02:11:55 +00:00
Nadav Rotem 9f20781bad Docs: mention that we support float reductions when -ffast-math is used.
llvm-svn: 171873
2013-01-08 17:46:30 +00:00
Eric Christopher 72a529566c Remove the llvm-local DW_TAG_vector_type tag and add a test to
make sure that vector types do work.

llvm-svn: 171833
2013-01-08 01:53:52 +00:00
Eric Christopher 9948d5eb6f Remove what appears to be a dead llvm-specific debug tag.
llvm-svn: 171821
2013-01-08 00:16:33 +00:00
Dmitri Gribenko 0655f6c3d9 Documentation: add a note that Clang on Mageia 2 can not find libstdc++ headers
llvm-svn: 171729
2013-01-07 12:17:44 +00:00
David Blaikie 8e390ea199 Documentation updates for pointer-to-member debug info added in r171698.
llvm-svn: 171701
2013-01-07 06:02:07 +00:00
Sean Silva 1b60018178 tblgen, docs: Add initial syntax reference.
llvm-svn: 171685
2013-01-07 02:43:44 +00:00
Dmitri Gribenko d326f6723a Documentation: add clang 3.0 + libstdc++ 4.7.x as a known bad combination that
is actually used by a few Linux distributions

llvm-svn: 171671
2013-01-06 21:23:27 +00:00
Renato Golin cd48362e62 Add reference to dcommit on GettingStarted
Signed-off-by: Renato Golin <renato.golin@linaro.org>
llvm-svn: 171642
2013-01-06 00:14:27 +00:00
Dmitri Gribenko 801e76900d GettingStarted: improve formatting and document that configure checks for
'clang' to use it as the compiler.

llvm-svn: 171630
2013-01-05 18:10:06 +00:00
Nadav Rotem 09b5a1be8b Update the gcc-loops benchmarks results with the new automatic unrolling feature.
llvm-svn: 171509
2013-01-04 19:10:34 +00:00
Eli Bendersky dcde5cb8da fix a couple of typos
llvm-svn: 171508
2013-01-04 19:09:15 +00:00
Nadav Rotem 014e19c2ca Add linpack-pc bench
llvm-svn: 171499
2013-01-04 19:00:42 +00:00
Nadav Rotem 7daadf21fe Update the docs about the new unroll features.
llvm-svn: 171470
2013-01-04 17:49:45 +00:00
Nadav Rotem 7ea18a763b Reformat the rst text.
llvm-svn: 171449
2013-01-03 01:56:33 +00:00
Nadav Rotem a616d68f2c LoopVectorizer: Document the unrolling feature.
llvm-svn: 171445
2013-01-03 01:47:02 +00:00
Sean Silva e3c5e48fc4 docs: update docs/README.txt and make it useful.
llvm-svn: 171353
2013-01-02 02:31:51 +00:00
NAKAMURA Takumi 43632a26a5 Update the copyright coredits -- Happy new year 2013!
llvm-svn: 171342
2013-01-01 10:00:19 +00:00
Sean Silva 6e4ebb5424 docs: Fix FIXME
I actually made a think-o when writing this FIXME since I wrote LangRef
but it should actually have said WritingAnLLVMBackend.

llvm-svn: 171293
2012-12-31 11:49:51 +00:00
Dmitri Gribenko 12be928dfb Documentation: add a section to prevent spurious test failures like the one
fixed in r171243.

llvm-svn: 171258
2012-12-30 14:51:03 +00:00
Sean Silva 0f2eabce10 docs: Add FAQ about "storing to a virtual register".
This came up for the N+1'st time today in IRC.

llvm-svn: 171155
2012-12-27 10:23:04 +00:00
Sean Silva 33fc6cff4b docs: Move link to the new "external tutorials" area.
llvm-svn: 171154
2012-12-27 08:57:08 +00:00
Nadav Rotem f85d3ee072 docs: Update the benchmark with updated perf numbers.
llvm-svn: 171149
2012-12-27 08:32:44 +00:00
Nadav Rotem 0bbf81e311 Update the docs with the new workload that was added.
llvm-svn: 171115
2012-12-26 19:45:00 +00:00
Nadav Rotem a1d2436b5f revert an accidental commit.
llvm-svn: 171098
2012-12-26 06:16:03 +00:00
Nadav Rotem 7375d35711 Doc: add fmuladd to the list of vectorizeable functions. Thanks hfinkel.
llvm-svn: 171094
2012-12-26 06:03:35 +00:00
Dmitri Gribenko 32e0aa3a50 Documentation: fix typos reported in PR13866
llvm-svn: 171006
2012-12-23 18:46:11 +00:00
Sean Silva ff120c7fc5 docs: Add link to external LLVM backend tutorial.
llvm-svn: 170998
2012-12-23 07:34:51 +00:00
Sean Silva 850861df62 docs: More robust image scaling fix.
Hopefully these benchmarks will be updated in the future, so avoid
hardcoding image dimensions.

llvm-svn: 170819
2012-12-21 00:28:42 +00:00
Sean Silva 35915c6459 docs: Prevent image scaling.
Tell the image to be its natural size.

llvm-svn: 170816
2012-12-21 00:20:25 +00:00
Sean Silva e9ba463632 docs: Try out nosidebar.
Please squawk if you find this appalling or otherwise don't like it.

llvm-svn: 170803
2012-12-20 23:35:22 +00:00
Sean Silva 287e7d275c docs: Cleanup trailing whitespace.
llvm-svn: 170799
2012-12-20 22:59:36 +00:00
Sean Silva e140b2ee67 docs: actually indent these consistently
llvm-svn: 170792
2012-12-20 22:49:13 +00:00
Sean Silva 8c44a4733c docs: Indent consistently in code examples.
llvm-svn: 170791
2012-12-20 22:47:41 +00:00
Sean Silva 99e12f91a6 docs: Improve navigation for Vectorizers.rst
Add links in the intro paragraph.
Add table of contents.

llvm-svn: 170790
2012-12-20 22:42:20 +00:00
Sean Silva fd706f7da9 docs: bring back link for reddit.
llvm-svn: 170776
2012-12-20 22:24:37 +00:00
Sean Silva eae2d90508 docs: Make document name congruent with title.
Hopefully nobody has linked to it yet...

OK'd by Nadav.

llvm-svn: 170768
2012-12-20 21:50:41 +00:00
James Molloy 4f6fb953a7 Add a new attribute, 'noduplicate'. If a function contains a noduplicate call, the call cannot be duplicated - Jump threading, loop unrolling, loop unswitching, and loop rotation are inhibited if they would duplicate the call.
Similarly inlining of the function is inhibited, if that would duplicate the call (in particular inlining is still allowed when there is only one callsite and the function has internal linkage).

llvm-svn: 170704
2012-12-20 16:04:27 +00:00
Sean Silva fe15616449 docs: Show TOC for GettingStarted.rst.
This is a pretty lengthy document, so put the table of contents in your
face so that it's easier to scope out the content.

This document is a mess currently and needs to be
refactored/revised/split-up.

llvm-svn: 170646
2012-12-20 03:32:39 +00:00
Sean Silva 08fd0888cb docs: Clean up adornments.
For whatever reason the usage of '^^^' and '---' adornments were
reversed compared to the "canonical" style of the LLVM docs (which is
currently "the style used in SphinxQuickstartTemplate.rst"). This change
doesn't affect the document structure at all, I'm just doing it for
trivial stylistic consistency (the document content is *much* more
important---thanks Nadav for writing this up!).

Also, trim the adornments to be the same length as the section names.

llvm-svn: 170638
2012-12-20 02:40:45 +00:00
Sean Silva 13ed79c66b docs: ASCII-fy
llvm-svn: 170637
2012-12-20 02:23:25 +00:00
Nadav Rotem 17d745618e doc: resize the image.
llvm-svn: 170622
2012-12-20 00:29:18 +00:00
Nadav Rotem 12da396abc Doc: update the chart.
llvm-svn: 170618
2012-12-20 00:03:36 +00:00
Meador Inge 0fbf321af2 docs: Fix title underline warnings
Building Vectorizers.rst produces a few warnings of the form:

   WARNING: Title underline too short.

Fixed by adding the extra needed dashes under the title.

llvm-svn: 170582
2012-12-19 20:16:40 +00:00
Nadav Rotem 0328f5e57d doc: add subsections.
llvm-svn: 170568
2012-12-19 18:04:44 +00:00
Nadav Rotem 8f4a6cced2 DOC: document the use of O2, O3 and Os with -fvectorize.
llvm-svn: 170567
2012-12-19 18:02:36 +00:00
Dmitri Gribenko d3be5d9bf6 Documentation: add a missing space
llvm-svn: 170542
2012-12-19 12:51:48 +00:00
Nadav Rotem 90c8b4bfa5 DOC: fix the url format.
llvm-svn: 170513
2012-12-19 08:43:05 +00:00
Nadav Rotem 15bdbbe309 DOC: add a benchmarks that compares us to gcc and icc.
llvm-svn: 170509
2012-12-19 08:28:24 +00:00
Nadav Rotem af14a3f20b docs: fix typos.
llvm-svn: 170504
2012-12-19 07:36:35 +00:00
Nadav Rotem c4efbb8b4e DOC: Add a webpage that describes the loop and bb vectorizers.
llvm-svn: 170503
2012-12-19 07:22:24 +00:00
Chandler Carruth 9dcfcf50c2 Actually update the grammar of this sentence to reflect the removal of CellSPU.
llvm-svn: 170268
2012-12-15 08:56:20 +00:00
Duncan Sands 503ce6953f Release notes for dragonegg 3.2.
llvm-svn: 170243
2012-12-14 21:10:59 +00:00
Chandler Carruth 58b3cb6cc2 The CellSPU backend is more than experimental, it's dead now...
llvm-svn: 170201
2012-12-14 13:44:05 +00:00
Chandler Carruth 1e83227942 Remove a section that was in 3.1's notes.
Just give a shout if this was actually still important....

llvm-svn: 170200
2012-12-14 13:43:59 +00:00
Chandler Carruth e6ccc13dbb Remove several entries from the 3.2 release notes that were in the 3.1
release notes already. =]

llvm-svn: 170198
2012-12-14 13:41:02 +00:00
Chandler Carruth 7c5d60c01d Fix the order of these sections of the release notes.
llvm-svn: 170197
2012-12-14 13:37:18 +00:00
Chandler Carruth 108d19e6b5 Add a rough draft of some content about the new SROA. I'll try to proof
read this and clean it up tomorrow, but hopefully it's a good
placeholder.

llvm-svn: 170196
2012-12-14 13:37:17 +00:00
Chandler Carruth b745ac48a6 Delete a long-stale "if its ready" comment. All indications is that this
will look a bit different when we have time to get it ready to turn on,
and we won't likely need this reminder.

llvm-svn: 170195
2012-12-14 13:37:12 +00:00
Chandler Carruth ec86541e9f Provide some actual highlight bullets for Clang.
If anyone has better highlights (I'm obviously biased by the things that
I'm excited about) jump in and add them!

llvm-svn: 170194
2012-12-14 13:22:57 +00:00
Sean Silva f77e570557 docs: Improve discussion of syntax highlighting.
llvm-svn: 170145
2012-12-13 20:14:25 +00:00
Dmitri Gribenko 90fa0c6194 Documentation: CompilerWriterInfo.rst: update link to Intel documentation
Replaces old Pentium 4 documentation link with generic current documentation link.

Patch by Kevin Schoedel.

llvm-svn: 170144
2012-12-13 20:02:11 +00:00
Dmitri Gribenko b70e6b64a5 Add a dummy documentation file to unbreak 'make install'. We need to find how
to package reST-formatted documentation.

llvm-svn: 170126
2012-12-13 13:37:35 +00:00
Dmitri Gribenko aa0e77cf24 Makefile.sphinx: reST conversion is complete!
No need to copy HTML files anymore.

llvm-svn: 170029
2012-12-12 21:35:43 +00:00
Dmitri Gribenko 508d98f67f Documentation: use paths relative to document root in links.
llvm-svn: 170027
2012-12-12 21:16:29 +00:00
Nick Kledzik f60a9279ea Initial implementation of a utility for converting native data
structures to and from YAML using traits.  The first client will
be the test suite of lld.  The documentation will show up at:

   http://llvm.org/docs/YamlIO.html

llvm-svn: 170019
2012-12-12 20:46:15 +00:00
Dmitri Gribenko f8bb4eadca Documentation: SphinxQuickstartTemplate.rst: add guidelines about highlighting
console sessions and add more highlighter names.

llvm-svn: 170011
2012-12-12 20:07:18 +00:00
Dmitri Gribenko 28574d36aa Documentation: llvm-bcanalyzer.rst: cleanup.
llvm-svn: 170001
2012-12-12 19:15:53 +00:00
Dmitri Gribenko 3fa700f17d Documentation: AliasAnalysis.rst: improve internal and external links
llvm-svn: 169993
2012-12-12 17:03:50 +00:00
Dmitri Gribenko 11ffe2c47e Documentation: convert WritingAnLLVMPass.html to reST.
Patch by Anthony Mykhailenko with small fixes by me.

llvm-svn: 169992
2012-12-12 17:02:44 +00:00
Dmitri Gribenko 427cfcb937 Documentation: cleanup
llvm-svn: 169990
2012-12-12 16:58:13 +00:00
Dmitri Gribenko 99e8b43498 Documentation: use a 'console' highlighter for terminal output examples. This
gives a nicer output than 'bash'.

llvm-svn: 169981
2012-12-12 14:23:14 +00:00
Dmitri Gribenko 125939cbf7 Documentation: use a 'console' highlighter for terminal output examples. This
gives a nicer output than 'bash'.

llvm-svn: 169979
2012-12-12 13:56:37 +00:00
Dmitri Gribenko 134f76a2bc Documentation: cleanup: remove useless anchors and write :ref:s explicitly.
llvm-svn: 169932
2012-12-11 23:35:23 +00:00
Dmitri Gribenko a2d35d153f Documentation: Lexicon.rst: add 'SLP' acronym
llvm-svn: 169928
2012-12-11 23:13:23 +00:00
Dmitri Gribenko ed4325f7ac Documentation: convert Passes.html to reST.
Since now we have an autogenerated TOC, a manually written table of all passes
was removed.

Patch by Anthony Mykhailenko with small fixes by me.

llvm-svn: 169867
2012-12-11 15:29:37 +00:00
Dmitri Gribenko 38782b8e87 Documentation: convert ReleaseNotes.html to reST.
Patch by Anthony Mykhailenko with small fixes by me.

llvm-svn: 169714
2012-12-09 23:14:26 +00:00
Chris Lattner c11b91ec18 So many people have touched this, it doesn't make sense to ascribe authorship anymore.
llvm-svn: 169704
2012-12-09 16:55:39 +00:00
Sean Silva 18dc538690 docs: Convert GarbageCollection.html to reST
Patch by Alexander Zinenko!

llvm-svn: 169702
2012-12-09 15:52:47 +00:00
Dmitri Gribenko 2247085c37 Documentation: HowToReleaseLLVM.rst: remove trailing whitespace.
llvm-svn: 169700
2012-12-09 15:33:26 +00:00
Dmitri Gribenko 0c79cd6107 Documentation: don't create TOCs manually.
Thanks to Sean Silva for pointing out!

llvm-svn: 169699
2012-12-09 15:29:56 +00:00
John Criswell be7f2f9e49 Fixed some grammar and punctuation error.
No content changes.

llvm-svn: 169627
2012-12-07 19:21:10 +00:00
Dmitri Gribenko 7a93668614 Convert HowToReleaseLLVM.html to reST
Patch by Alexander Zinenko.

llvm-svn: 169608
2012-12-07 16:42:48 +00:00
Sean Silva b084af416a docs: Convert LangRef to reST.
NOTE: If you have any patches in the works that modify LangRef, you will
need to rewrite the changes to LangRef.html to their equivalents in
LangRef.rst. If you need assistance feel free to contact me.

Since LangRef is mission-critical for the project and "normative", I
have taken extra care to ensure that no content was lost or altered in
the conversion. The content was converted with a tool called `pandoc`,
so there is no chance for a human error like accidentally forgetting a
sentence or whatever. After the initial conversion by `pandoc`, only
changes to the markup were done.

This is just the most literal conversion of the HTML document as
possible. It might be worth exploring some way to chop up this massive
document into separate pages, e.g. something like
`docs/LangRef/Instructions.rst`, `docs/LangRef/Intrinsics.rst`, etc.
with `docs/LangRef.rst` being an "intro/navigation page" of sorts. On
the other hand, that loses the ability to {Ctrl,Cmd}-F for a given term
right from your browser.

IMO, I think our stylesheet needs some work because I find it hard to
tell what level of nesting some of the headings are at (e.g. "is this a
new section or is it a subsection?"). The issue is present on other
pages, but the sheer size and deep section structure of LangRef really
brings this issue out. If there are any web designers out there in the
community it would be awesome if you tried to come up with something
nicer.

llvm-svn: 169596
2012-12-07 10:36:55 +00:00
Dmitri Gribenko 8150e9e55a Documentation: fix typos and formatting.
llvm-svn: 169546
2012-12-06 21:12:35 +00:00
Sean Silva 33af5003c7 docs: Explain plain preformatted text
llvm-svn: 169352
2012-12-05 04:07:33 +00:00
Sean Silva d7fb396eb2 docs: Sphinxify `docs/tutorial/`
Sorry for the massive commit, but I just wanted to knock this one down
and it is really straightforward.

There are still a couple trivial (i.e. not related to the content)
things left to fix:

- Use of raw HTML links where :doc:`...` and :ref:`...` could be used
  instead. If you are a newbie and want to help fix this it would make
  for some good bite-sized patches; more experienced developers should
  be focusing on adding new content (to this tutorial or elsewhere, but
  please _do not_ waste your time on formatting when there is such dire
  need for documentation (see docs/SphinxQuickstartTemplate.rst to get
  started writing)).

- Highlighting of the kaleidoscope code blocks (currently left as bare
  `::`).  I will be working on writing a custom Pygments highlighter for
  this, mostly as training for maintaining the `llvm` code-block's lexer
  in-tree. I want to do this because I am extremely unhappy with how it
  just "gives up" on the slightest deviation from the expected syntax
  and leaves the whole code-block un-highlighted.

  More generally I am looking at writing some Sphinx extensions and
  keeping them in-tree as well, to support common use cases that
  currently have no good solution (like "monospace text inside a link").

llvm-svn: 169343
2012-12-05 00:26:32 +00:00
Sean Silva f75e74f67e docs: Begin Sphinxification of docs/tutorial/
llvm-svn: 169309
2012-12-04 21:16:41 +00:00
Sean Silva 8f14642ae0 docs: fixup legacy HTML link
llvm-svn: 169308
2012-12-04 21:16:34 +00:00
Justin Holewinski ed7d8d5500 Update release notes for NVPTX
llvm-svn: 169280
2012-12-04 16:11:51 +00:00
Eli Bendersky 0ffc0d4ff3 Get rid of references to Tcl, DejagGNU, old test structure, discourage the use
of grep in favor of FileCheck, and other cleanups.

llvm-svn: 169269
2012-12-04 14:34:00 +00:00
Eli Bendersky 42e10733ae Remove the very out-of-date listing of "very important LLVM areas". I don't
think it adds much and keeping it up-to-date is (obviously) a chore.

llvm-svn: 169263
2012-12-04 13:55:17 +00:00
Sean Silva c454f07e33 docs: Fix broken link.
llvm-svn: 169211
2012-12-04 03:45:27 +00:00
Sean Silva 4b587854fe docs: Fix dead link.
Apparently Dinkumware are no longer hosting their nice reference
manuals. Thankfully, `cppreference.com` can fill that role well.

llvm-svn: 169210
2012-12-04 03:30:36 +00:00
Sean Silva beb15ca8f0 docs: Convert ProgrammersManual to reST.
Patch by Alexander Zinenko!

llvm-svn: 169208
2012-12-04 03:20:08 +00:00
Eli Bendersky 035513831b Clean up, bring up-to-date and apply consistent formatting.
This document is a long-time pet peeve :-) More fixes to come.

llvm-svn: 169115
2012-12-03 04:10:58 +00:00
Chandler Carruth 494cfc0786 Simplify the coding standards for #include ordering. The ordering is now
trivially achievable with an editor. I'll likely check in a silly python
script to help with this too.

llvm-svn: 169107
2012-12-02 11:53:27 +00:00
Justin Holewinski 0bd335efcd Unbreak Sphinx build
llvm-svn: 169106
2012-12-02 02:47:48 +00:00