ReleaseNotes: note Sphinx migration.
[oota-llvm.git] / docs / ReleaseNotes.rst
1 ======================
2 LLVM 3.3 Release Notes
3 ======================
4
5 .. contents::
6     :local:
7
8 .. warning::
9    These are in-progress notes for the upcoming LLVM 3.3 release.  You may
10    prefer the `LLVM 3.2 Release Notes <http://llvm.org/releases/3.2/docs
11    /ReleaseNotes.html>`_.
12
13
14 Introduction
15 ============
16
17 This document contains the release notes for the LLVM Compiler Infrastructure,
18 release 3.3.  Here we describe the status of LLVM, including major improvements
19 from the previous release, improvements in various subprojects of LLVM, and
20 some of the current users of the code.  All LLVM releases may be downloaded
21 from the `LLVM releases web site <http://llvm.org/releases/>`_.
22
23 For more information about LLVM, including information about the latest
24 release, please check out the `main LLVM web site <http://llvm.org/>`_.  If you
25 have questions or comments, the `LLVM Developer's Mailing List
26 <http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_ is a good place to send
27 them.
28
29 Note that if you are reading this file from a Subversion checkout or the main
30 LLVM web page, this document applies to the *next* release, not the current
31 one.  To see the release notes for a specific release, please see the `releases
32 page <http://llvm.org/releases/>`_.
33
34 Non-comprehensive list of changes in this release
35 =================================================
36
37 .. NOTE
38    For small 1-3 sentence descriptions, just add an entry at the end of
39    this list. If your description won't fit comfortably in one bullet
40    point (e.g. maybe you would like to give an example of the
41    functionality, or simply have a lot to talk about), see the `NOTE` below
42    for adding a new subsection.
43
44 * The CellSPU port has been removed.  It can still be found in older versions.
45
46 * The IR-level extended linker APIs (for example, to link bitcode files out of
47   archives) have been removed. Any existing clients of these features should
48   move to using a linker with integrated LTO support.
49
50 * LLVM and Clang's documentation has been migrated to the `Sphinx
51   <http://sphinx-doc.org/>`_ documentation generation system which uses
52   easy-to-write reStructuredText. See `llvm/docs/README.txt` for more
53   information.
54
55 * ... next change ...
56
57 .. NOTE
58    If you would like to document a larger change, then you can add a
59    subsection about it right here. You can copy the following boilerplate
60    and un-indent it (the indentation causes it to be inside this comment).
61
62    Special New Feature
63    -------------------
64
65    Makes programs 10x faster by doing Special New Thing.
66
67 Additional Information
68 ======================
69
70 A wide variety of additional information is available on the `LLVM web page
71 <http://llvm.org/>`_, in particular in the `documentation
72 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
73 API documentation which is up-to-date with the Subversion version of the source
74 code.  You can access versions of these documents specific to this release by
75 going into the ``llvm/docs/`` directory in the LLVM tree.
76
77 If you have any questions or comments about LLVM, please feel free to contact
78 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
79