c0d2ea18981e6602f8a78a7fc29b97e593b26310
[oota-llvm.git] / docs / ReleaseNotes.rst
1 ======================
2 LLVM 3.7 Release Notes
3 ======================
4
5 .. contents::
6     :local:
7
8 .. warning::
9    These are in-progress notes for the upcoming LLVM 3.7 release.  You may
10    prefer the `LLVM 3.6 Release Notes <http://llvm.org/releases/3.6.0/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.7.  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 minimum required Visual Studio version for building LLVM is now 2013
45   Update 4.
46
47 * A new documentation page, :doc:`Frontend/PerformanceTips`, contains a
48   collection of tips for frontend authors on how to generate IR which LLVM is
49   able to effectively optimize.
50
51 * The DataLayout is no longer optional. All the IR level optimizations expects
52   it to be present and the API has been changed to use a reference instead of
53   a pointer to make it explicit. The Module owns the datalayout and it has to
54   match the one attached to the TargetMachine for generating code.
55
56 * ... next change ...
57
58 .. NOTE
59    If you would like to document a larger change, then you can add a
60    subsection about it right here. You can copy the following boilerplate
61    and un-indent it (the indentation causes it to be inside this comment).
62
63    Special New Feature
64    -------------------
65
66    Makes programs 10x faster by doing Special New Thing.
67
68 Changes to the ARM Backend
69 --------------------------
70
71  During this release ...
72
73
74 Changes to the MIPS Target
75 --------------------------
76
77  During this release ...
78
79
80 Changes to the PowerPC Target
81 -----------------------------
82
83  During this release ...
84
85
86 Changes to the OCaml bindings
87 -----------------------------
88
89  During this release ...
90
91
92 External Open Source Projects Using LLVM 3.7
93 ============================================
94
95 An exciting aspect of LLVM is that it is used as an enabling technology for
96 a lot of other language and tools projects. This section lists some of the
97 projects that have already been updated to work with LLVM 3.7.
98
99 * A project
100
101
102 Additional Information
103 ======================
104
105 A wide variety of additional information is available on the `LLVM web page
106 <http://llvm.org/>`_, in particular in the `documentation
107 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
108 API documentation which is up-to-date with the Subversion version of the source
109 code.  You can access versions of these documents specific to this release by
110 going into the ``llvm/docs/`` directory in the LLVM tree.
111
112 If you have any questions or comments about LLVM, please feel free to contact
113 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
114