Disable use list order on the gold plugin.
[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 * The C API function LLVMLinkModules is deprecated. It will be removed in the
45   3.9 release. Please migrate to LLVMLinkModules2. Unlike the old function the
46   new one
47
48    * Doesn't take an unused parameter.
49    * Destroys the source instead of only damaging it.
50    * Does not record a message. Use the diagnostic handler instead.
51
52 * The C API functions LLVMParseBitcode, LLVMParseBitcodeInContext,
53   LLVMGetBitcodeModuleInContext and LLVMGetBitcodeModule have been deprecated.
54   They will be removed in 3.9. Please migrate to the versions with a 2 suffix.
55   Unlike the old ones the new ones do not record a diagnostic message. Use
56   the diagnostic handler instead.
57
58 * The deprecated C APIs LLVMGetBitcodeModuleProviderInContext and
59   LLVMGetBitcodeModuleProvider have been removed.
60
61 * The deprecated C APIs LLVMCreateExecutionEngine, LLVMCreateInterpreter,
62   LLVMCreateJITCompiler, LLVMAddModuleProvider and LLVMRemoveModuleProvider
63   have been removed.
64
65 * With this release, the C API headers have been reorganized to improve build
66   time. Type specific declarations have been moved to Type.h, and error
67   handling routines have been moved to ErrorHandling.h. Both are included in
68   Core.h so nothing should change for projects directly including the headers,
69   but transitive dependencies may be affected.
70
71 .. NOTE
72    For small 1-3 sentence descriptions, just add an entry at the end of
73    this list. If your description won't fit comfortably in one bullet
74    point (e.g. maybe you would like to give an example of the
75    functionality, or simply have a lot to talk about), see the `NOTE` below
76    for adding a new subsection.
77
78 * ... next change ...
79
80 .. NOTE
81    If you would like to document a larger change, then you can add a
82    subsection about it right here. You can copy the following boilerplate
83    and un-indent it (the indentation causes it to be inside this comment).
84
85    Special New Feature
86    -------------------
87
88    Makes programs 10x faster by doing Special New Thing.
89
90 Changes to the ARM Backend
91 --------------------------
92
93  During this release ...
94
95
96 Changes to the MIPS Target
97 --------------------------
98
99  During this release ...
100
101
102 Changes to the PowerPC Target
103 -----------------------------
104
105  During this release ...
106
107
108 Changes to the X86 Target
109 -----------------------------
110
111  During this release ...
112
113 * TLS is enabled for Cygwin as emutls.
114
115
116 Changes to the OCaml bindings
117 -----------------------------
118
119  During this release ...
120
121 * The ocaml function link_modules has been replaced with link_modules' which
122   uses LLVMLinkModules2.
123
124
125 External Open Source Projects Using LLVM 3.8
126 ============================================
127
128 An exciting aspect of LLVM is that it is used as an enabling technology for
129 a lot of other language and tools projects. This section lists some of the
130 projects that have already been updated to work with LLVM 3.8.
131
132 * A project
133
134
135 Additional Information
136 ======================
137
138 A wide variety of additional information is available on the `LLVM web page
139 <http://llvm.org/>`_, in particular in the `documentation
140 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
141 API documentation which is up-to-date with the Subversion version of the source
142 code.  You can access versions of these documents specific to this release by
143 going into the ``llvm/docs/`` directory in the LLVM tree.
144
145 If you have any questions or comments about LLVM, please feel free to contact
146 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
147