ba7e436fb0ea75dc24738a8de21c96ddd4b84899
[oota-llvm.git] / docs / ReleaseNotes.rst
1 ======================
2 LLVM 3.8 Release Notes
3 ======================
4
5 .. contents::
6     :local:
7
8 .. warning::
9    These are in-progress notes for the upcoming LLVM 3.8 release.  You may
10    prefer the `LLVM 3.7 Release Notes <http://llvm.org/releases/3.7.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.8.  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.llvm.org/mailman/listinfo/llvm-dev>`_ 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 * With this release, the minimum Windows version required for running LLVM is
37   Windows 7. Earlier versions, including Windows Vista and XP are no longer
38   supported.
39
40 * With this release, the autoconf build system is deprecated. It will be removed
41   in the 3.9 release. Please migrate to using CMake. For more information see:
42   `Building LLVM with CMake <CMake.html>`_
43
44 .. NOTE
45    For small 1-3 sentence descriptions, just add an entry at the end of
46    this list. If your description won't fit comfortably in one bullet
47    point (e.g. maybe you would like to give an example of the
48    functionality, or simply have a lot to talk about), see the `NOTE` below
49    for adding a new subsection.
50
51 * ... next change ...
52
53 .. NOTE
54    If you would like to document a larger change, then you can add a
55    subsection about it right here. You can copy the following boilerplate
56    and un-indent it (the indentation causes it to be inside this comment).
57
58    Special New Feature
59    -------------------
60
61    Makes programs 10x faster by doing Special New Thing.
62
63 Changes to the ARM Backend
64 --------------------------
65
66  During this release ...
67
68
69 Changes to the MIPS Target
70 --------------------------
71
72  During this release ...
73
74
75 Changes to the PowerPC Target
76 -----------------------------
77
78  During this release ...
79
80
81 Changes to the OCaml bindings
82 -----------------------------
83
84  During this release ...
85
86
87 External Open Source Projects Using LLVM 3.8
88 ============================================
89
90 An exciting aspect of LLVM is that it is used as an enabling technology for
91 a lot of other language and tools projects. This section lists some of the
92 projects that have already been updated to work with LLVM 3.8.
93
94 * A project
95
96
97 Additional Information
98 ======================
99
100 A wide variety of additional information is available on the `LLVM web page
101 <http://llvm.org/>`_, in particular in the `documentation
102 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
103 API documentation which is up-to-date with the Subversion version of the source
104 code.  You can access versions of these documents specific to this release by
105 going into the ``llvm/docs/`` directory in the LLVM tree.
106
107 If you have any questions or comments about LLVM, please feel free to contact
108 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
109