Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 1 | <html> |
| 2 | <head> |
| 3 | <title>Clang 3.0 Release Notes</title> |
| 4 | <link type="text/css" rel="stylesheet" href="../menu.css" /> |
| 5 | <link type="text/css" rel="stylesheet" href="../content.css" /> |
| 6 | <style type="text/css"> |
| 7 | td { |
| 8 | vertical-align: top; |
| 9 | } |
| 10 | </style> |
| 11 | </head> |
| 12 | <body> |
| 13 | |
| 14 | <!--#include virtual="../menu.html.incl"--> |
| 15 | |
| 16 | <div id="content"> |
| 17 | |
| 18 | <h1>Clang 3.0 Release Notes</h1> |
| 19 | |
| 20 | <img align=right src="http://llvm.org/img/DragonSmall.png" |
| 21 | width="136" height="136" alt="LLVM Dragon Logo"> |
| 22 | |
| 23 | <ul> |
| 24 | <li><a href="#intro">Introduction</a></li> |
| 25 | <li><a href="#whatsnew">What's New in Clang 3.0?</a> |
| 26 | <ul> |
| 27 | <li><a href="#majorfeatures">Major New Features</a></li> |
| 28 | <li><a href="#cchanges">C Language Changes</a></li> |
| 29 | <li><a href="#cxxhanges">C++ Language Changes</a></li> |
| 30 | <li><a href="#objchanges">Objective-C Language Changes</a></li> |
| 31 | <li><a href="#apichanges">Internal API Changes</a></li> |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 32 | </ul> |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 33 | </li> |
| 34 | <li><a href="#knownproblems">Known Problems</a></li> |
| 35 | <li><a href="#additionalinfo">Additional Information</a></li> |
| 36 | </ul> |
| 37 | |
| 38 | <div class="doc_author"> |
| 39 | <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p> |
| 40 | </div> |
| 41 | |
| 42 | <!-- |
| 43 | <h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0 |
| 44 | release.<br> |
| 45 | You may prefer the |
| 46 | <a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9 |
| 47 | Release Notes</a>.</h1> |
| 48 | --> |
| 49 | |
| 50 | <!-- ======================================================================= --> |
| 51 | <h2 id="intro">Introduction</h2> |
| 52 | <!-- ======================================================================= --> |
| 53 | |
| 54 | <p>This document contains the release notes for the Clang C/C++/Objective-C |
| 55 | frontend, part of the LLVM Compiler Infrastructure, release 3.0. Here we |
| 56 | describe the status of Clang in some detail, including major improvements from |
| 57 | the previous release and new feature work. For the general LLVM release notes, |
Peter Collingbourne | 5cc989e | 2011-11-29 02:03:03 +0000 | [diff] [blame] | 58 | see <a href="http://llvm.org/docs/ReleaseNotes.html">the LLVM |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 59 | documentation</a>. All LLVM releases may be downloaded from the |
| 60 | <a href="http://llvm.org/releases/">LLVM releases web site</a>.</p> |
| 61 | |
| 62 | <p>For more information about Clang or LLVM, including information about the |
| 63 | latest release, please check out the main please see the |
| 64 | <a href="http://clang.llvm.org">Clang Web Site</a> or the |
| 65 | <a href="http://llvm.org">LLVM Web Site</a>. |
| 66 | |
| 67 | <p>Note that if you are reading this file from a Subversion checkout or the main |
| 68 | Clang web page, this document applies to the <i>next</i> release, not the |
| 69 | current one. To see the release notes for a specific release, please see the |
| 70 | <a href="http://llvm.org/releases/">releases page</a>.</p> |
| 71 | |
| 72 | <!-- ======================================================================= --> |
| 73 | <h2 id="whatsnew">What's New in Clang 3.0?</h2> |
| 74 | <!-- ======================================================================= --> |
| 75 | |
| 76 | <p>Some of the major new features and improvements to Clang are listed here. |
| 77 | Generic improvements to Clang as a whole or two its underlying infrastructure |
| 78 | are described first, followed by language-specific sections with improvements to |
| 79 | Clang's support for those languages.</p> |
| 80 | |
| 81 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 82 | <h3 id="majorfeatures">Major New Features</h3> |
| 83 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 84 | |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 85 | <h4 id="diagnostics">A multitude of improvements to Clang's diagnostics</h4> |
| 86 | Clang's diagnostics are constantly being improved to catch more issues, explain |
| 87 | them more clearly, and provide more accurate source information about them. |
| 88 | A few improvements since the 2.9 release that have a particularly high impact: |
| 89 | <ul> |
| 90 | <li>Substantially shorter messages due to better recovery, fewer include |
| 91 | stacks, and tuning verbose features such as 'a.k.a.' type printing.</li> |
| 92 | <li> |
Chandler Carruth | ee77d3d | 2011-11-29 00:24:20 +0000 | [diff] [blame] | 93 | Able to recover and correct from misspelled type names at the beging of |
| 94 | statements. For example, Clang now emits: |
| 95 | <pre><b>t.c:6:3: <span class="error">error:</span> use of undeclared identifier 'integer'; did you mean 'Integer'?</b> |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 96 | integer *i = 0; |
Richard Smith | ad5459a | 2011-11-28 23:16:15 +0000 | [diff] [blame] | 97 | <span class="caret">^~~~~~~</span> |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 98 | Integer |
Richard Smith | ad5459a | 2011-11-28 23:16:15 +0000 | [diff] [blame] | 99 | <b>t.c:1:13: note:</b> 'Integer' declared here |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 100 | typedef int Integer; |
Richard Smith | ad5459a | 2011-11-28 23:16:15 +0000 | [diff] [blame] | 101 | <span class="caret">^</span></pre> |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 102 | </li> |
| 103 | <li>Expanded typo correction to (among other improvements) look across |
| 104 | namespaces and suggest namespace qualifiers in addition to misspellings of the |
| 105 | identifier itself.</li> |
| 106 | <li>More rich macro expansion backtraces and some (limited) fix-it hints when |
| 107 | diagnostics stem from macro arguments.</li> |
Chandler Carruth | 2f37685 | 2011-11-28 22:54:33 +0000 | [diff] [blame] | 108 | <li>Many new warnings have been added to catch common, bug-prone code |
| 109 | patterns.</li> |
| 110 | <li>Uninitialized values Clang warning was rewritten to be more accurate, |
| 111 | faster, and able to differentiate between the <em>possibility</em> of an |
| 112 | uninitialized use and the <em>certainty</em> of an uninitialized use.</li> |
Chandler Carruth | 58f2cbc | 2011-11-28 22:34:59 +0000 | [diff] [blame] | 113 | </ul> |
| 114 | |
Chandler Carruth | 9a16712 | 2011-11-28 22:43:32 +0000 | [diff] [blame] | 115 | <h4 id="libclang">This release saw significant improvements to <code>libclang</code></h4> |
| 116 | <ul> |
| 117 | <li>A broader set of the <code>libclang</code> API is exposed in the Python |
| 118 | bindings.</li> |
| 119 | <li>Much more of the Clang AST is exposed through <code>libclang</code>'s APIs |
| 120 | and cursors.</li> |
| 121 | <li>Cursors can now walk more effectively through macros, especially arguments |
| 122 | to function-style macros, and resolve to the underlying AST.</li> |
| 123 | <li>Improved code completion surrounding macros, macro arguments, and |
| 124 | token pasting.</li> |
| 125 | <li>Improved code completion for in-class member functions.</li> |
| 126 | <li>Crash recovery for <code>libclang</code> clients.</li> |
| 127 | <!-- Doug or Ted may want to flesh this out if there are relevant details I'm |
| 128 | glossing over... --> |
| 129 | </ul> |
| 130 | |
Chandler Carruth | b882a1d | 2011-11-28 21:56:30 +0000 | [diff] [blame] | 131 | <h4 id="driver">The Clang GCC-compatible command-line driver improved dramatically</h4> |
| 132 | A great deal of work went into the GCC-compatible driver for the 3.0 release |
| 133 | making it support more operating systems, emulate GCC behavior more accurately, |
| 134 | and support a much broader range of Linux distributions out of the box. |
| 135 | <ul> |
| 136 | <li>More accurate support for hardware architecture pre-defined macros (e.g., |
| 137 | __i686__).</li> |
| 138 | <li>Robust library and header search paths for the vast majority of x86 and |
| 139 | x86-64 Linux distributions.</li> |
| 140 | <li>Improved support for newer Darwin platforms.</li> |
| 141 | <li>Partial support for <code>--sysroot=...</code> based cross-compiling on |
| 142 | Linux (and similar) host systems.</li> |
| 143 | <li>Improved support for locating and using libcxx when installed, especially |
| 144 | on Darwin.</li> |
| 145 | <!-- There are likely more Darwin-specific improvements to mention here? --> |
| 146 | <!-- What support was added for FreeBSD? NetBSD? Anything noteworthy? --> |
Chandler Carruth | 2f37685 | 2011-11-28 22:54:33 +0000 | [diff] [blame] | 147 | <li>Automatic detection of Clang crashes in the driver and preparation of |
| 148 | reproduction steps for filing bug reports.</li><!-- Chad, feel free to add |
| 149 | more details here. --> |
Chandler Carruth | b882a1d | 2011-11-28 21:56:30 +0000 | [diff] [blame] | 150 | </ul> |
| 151 | |
Chandler Carruth | c6f2af3 | 2011-11-28 19:17:25 +0000 | [diff] [blame] | 152 | <h4 id="ppcallbacks">Expanded support for instrumenting the preprocessor through |
| 153 | callbacks</h4> |
Chandler Carruth | f16d725 | 2011-11-28 21:47:51 +0000 | [diff] [blame] | 154 | Several enhancements were made to the <code>PPCallbacks</code> interface to |
| 155 | expand the information available to tools and library users of Clang that wish |
| 156 | to introspect the preprocessing. |
Chandler Carruth | c6f2af3 | 2011-11-28 19:17:25 +0000 | [diff] [blame] | 157 | <ul> |
| 158 | <li>The exact text used between the <code>""</code>s or <code><></code>s is reported.</li> |
| 159 | <li>The header search path used to locate the header is reported.</li> |
| 160 | <li>Missing files during including headers reported.</li> |
| 161 | <li>The exact source range for expanded macros can be retrieved.</li> |
| 162 | </ul> |
| 163 | |
Chandler Carruth | 185e930 | 2011-11-28 23:11:27 +0000 | [diff] [blame] | 164 | <h4 id="windows">Clang is building and tested regularly on Windows and can |
| 165 | compile limited subsets of code on Windows</h4> |
| 166 | Clang is regularly built and tested on a variety of Windows platforms including |
| 167 | MinGW 32-bit and 64-bit, Cygwin, and natively with MSVC. In addition, Clang can |
| 168 | be used as a compiler in a few Windows contexts. |
| 169 | <ul> |
| 170 | <li>Normal compilation supported for the MinGW target platform, in both 32-bit |
| 171 | and 64-bit, and the Cygwin target platform.</li> |
| 172 | <li>Parsing and AST support for Windows Structured Exception Handling.</li> |
Francois Pichet | 551988f | 2011-11-28 23:30:46 +0000 | [diff] [blame] | 173 | <li>New -fms-compatibility flag to handle MSVC constructs that could change |
| 174 | the meaning of an otherwise well formed program</li> |
| 175 | <li>clang can now parse all the MSVC 2010 standard C++ header files |
| 176 | in the nominal case, (still need to specifiy -nobuiltininc for some headers).</li> |
| 177 | <li>Improved support for MFC code parsing, (still a work in progress).</li> |
Francois Pichet | 0c2198a | 2011-11-28 23:46:15 +0000 | [diff] [blame] | 178 | <li>Add support for function template specialization at class scope (-fms-extensions mode).</li> |
| 179 | <li>Add support for Microsoft __if_exists/__if_not_exists statements (-fms-extensions mode).</li> |
Chandler Carruth | 185e930 | 2011-11-28 23:11:27 +0000 | [diff] [blame] | 180 | </ul> |
| 181 | |
Chandler Carruth | 45901b3 | 2011-11-29 00:15:26 +0000 | [diff] [blame] | 182 | <h4 id="availability">New availability attribute to detect and warn about API |
| 183 | usage across OS X and iOS versions</h4> |
| 184 | Clang now supports an attribute which documents the availability of an API |
| 185 | across various platforms and releases, allowing interfaces to include |
| 186 | information about what OS versions support the relevant features. Based on the |
| 187 | targeted version of a compile, warnings for deprecated and unavailable |
| 188 | interfaces will automatically be provided by Clang. |
| 189 | |
| 190 | <h4 id="threadsafety">Thread Safety annotations and analysis-based warnings</h4> |
| 191 | A set of annotations were introduced to Clang to describe the various |
| 192 | thread-safety concerns of a program, and an accompanying set of analysis based |
| 193 | warnings will diagnose clearly unsafe code patterns. The annotations are |
| 194 | described in the |
| 195 | <a href="http://clang.llvm.org/docs/LanguageExtensions.html#threadsafety">extension specification</a>, |
| 196 | and the warnings currently supported include: |
| 197 | <ul> |
| 198 | <li>Calling functions without the required locks</li> |
| 199 | <li>Reading variables without the required locks</li> |
| 200 | <li>Writing to variables without an exclusive lock (even if holding a shared |
| 201 | lock)</li> |
| 202 | <li>Imbalance between locks and unlocks across loop entries and exits</li> |
| 203 | <li>Acquiring or releasing locks out of order</li> |
| 204 | </ul> |
| 205 | |
| 206 | <h4 id="incompleteast">Improved support for partially constructed and/or |
| 207 | incomplete ASTs</h4> |
| 208 | For users such as LLDB that are dynamically forming C++ ASTs, sometimes it is |
| 209 | either necessary or useful to form a partial or incomplete AST. Support for |
| 210 | these use cases have improved through the introduction of "unknown" types and |
| 211 | other AST constructs designed specifically for use cases without complete |
| 212 | information about the C++ construct being formed. |
| 213 | |
Peter Collingbourne | 375f7c4 | 2011-11-29 02:03:07 +0000 | [diff] [blame] | 214 | <h4 id="opencl">Initial work to support compiling OpenCL C with Clang</h4> |
| 215 | <p>Clang has some (limited) support for compiling OpenCL C. The 3.0 |
| 216 | release adds support for the <tt>vec_step</tt> operator, address space |
| 217 | qualifiers (<tt>__private</tt>, <tt>__global</tt>, <tt>__local</tt> and |
| 218 | <tt>__constant</tt>), improved vector literal support and code generation |
| 219 | support for the <a href="http://llvm.org/docs/ReleaseNotes.html#PTX">PTX |
| 220 | target</a>.</p> |
Chandler Carruth | a0df07d | 2011-11-28 22:17:58 +0000 | [diff] [blame] | 221 | |
Peter Collingbourne | 375f7c4 | 2011-11-29 02:03:07 +0000 | [diff] [blame] | 222 | <p>Using the <a href="http://www.pcc.me.uk/~peter/libclc/">libclc library</a> |
| 223 | to supply OpenCL C built-ins, you can use Clang to compile OpenCL C code |
| 224 | into PTX and execute it by loading the resulting PTX as a binary blob using |
| 225 | the nVidia OpenCL library. It has been tested with several OpenCL programs, |
| 226 | including some from the nVidia GPU Computing SDK, and the performance is on |
| 227 | par with the nVidia compiler.</p> |
Chandler Carruth | a0df07d | 2011-11-28 22:17:58 +0000 | [diff] [blame] | 228 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 229 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 230 | <h3 id="cchanges">C Language Changes in Clang</h3> |
| 231 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 232 | |
Richard Smith | 62d730f | 2011-11-28 22:48:25 +0000 | [diff] [blame] | 233 | <h4 id="c1xchanges">C1X Feature Support</h4> |
| 234 | |
| 235 | <p>Clang 3.0 adds support for the |
| 236 | <a href="http://clang.llvm.org/docs/LanguageExtensions.html#c1x"> |
| 237 | <code>_Alignas</code>, <code>_Generic</code>, and <code>_Static_assert</code> |
| 238 | keywords</a>, drafted for inclusion in the next C standard, which is |
| 239 | provisionally known as C1X. Use <code>-std=c1x</code> or <code>-std=gnu1x</code> |
| 240 | to enable support for the new language standard. These features are |
| 241 | backwards-compatible and are available as an extension in all language |
| 242 | modes.</p> |
| 243 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 244 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 245 | <h3 id="cxxchanges">C++ Language Changes in Clang</h3> |
| 246 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 247 | |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 248 | <h4 id="cxx11changes">C++11 Feature Support</h4> |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 249 | <p>Clang 3.0 adds support for |
| 250 | <a href="http://clang.llvm.org/cxx_status.html#cxx11">more of the language |
Richard Smith | 4793138 | 2011-11-28 23:35:03 +0000 | [diff] [blame] | 251 | features</a> added in the latest ISO C++ standard, |
| 252 | <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372">C++ 2011</a>. |
| 253 | Use <code>-std=c++11</code> or <code>-std=gnu++11</code> to enable support for |
| 254 | these features. The following are now considered to be of production quality: |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 255 | <ul> |
Chandler Carruth | f16d725 | 2011-11-28 21:47:51 +0000 | [diff] [blame] | 256 | <li>Range-based <code>for</code> loops</li> |
| 257 | <li>Alias declarations (a new syntax for <code>typedef</code> declarations), |
| 258 | including their <code>template</code> forms</li> |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 259 | <li>Specifying default values for class data members within a class |
| 260 | definition</li> |
| 261 | <li>Constructors delegating to other constructors of the same class</li> |
Chandler Carruth | f16d725 | 2011-11-28 21:47:51 +0000 | [diff] [blame] | 262 | <li>The <code>override</code> context-sensitive keyword for virtual member |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 263 | function declarations</li> |
Chandler Carruth | f16d725 | 2011-11-28 21:47:51 +0000 | [diff] [blame] | 264 | <li>Explicitly generating default function definitions with |
| 265 | <code>= default</code></li> |
| 266 | <li>The <code>nullptr</code> keyword, and the corresponding type</li> |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 267 | <li>Raw string literals with arbitary delimiters (for instance, |
Chandler Carruth | f16d725 | 2011-11-28 21:47:51 +0000 | [diff] [blame] | 268 | <code>R"delim(str"ing)delim"</code>)</li> |
| 269 | <li>Unicode string literals (for instance, <code>U"\u1234"</code>) and the |
| 270 | <code>char16_t</code> and <code>char32_t</code> built-in types |
| 271 | <li><code>noexcept</code> expressions and the <code>noexcept</code> specifier |
| 272 | on function declarations</li> |
| 273 | <li><code>alignof</code> expressions and the <code>alignas</code> specifier on |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 274 | variable declarations</li> |
| 275 | <li>A full set of <a href="http://clang.llvm.org/docs/LanguageExtensions.html#checking_type_traits">type traits</a>, |
| 276 | sufficient to support C++11 standard libraries</li> |
| 277 | </ul> |
Chandler Carruth | bc02a04 | 2011-11-28 21:55:34 +0000 | [diff] [blame] | 278 | All warning and language selection flags which previously accepted |
| 279 | <code>c++0x</code> now accept <code>c++11</code>. The old <code>c++0x</code> |
| 280 | form remains as an alias. |
Richard Smith | 855746b | 2011-11-28 20:02:05 +0000 | [diff] [blame] | 281 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 282 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 283 | <h3 id="objcchanges">Objective-C Language Changes in Clang</h3> |
| 284 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
Chandler Carruth | 4d58212 | 2011-11-29 00:15:23 +0000 | [diff] [blame] | 285 | Clang 3.0 introduces several new Objective-C language features and improvements. |
| 286 | |
| 287 | <h4 id="objc_arc">Objective-C Automatic Reference Counting</h4> |
| 288 | <!-- This is really just a stub for John to flesh out regarding ARC. --> |
| 289 | ARC provides automated memory management for Objective-C programs that is |
| 290 | compatible with existing retain/release code. ARC is carefully built to |
| 291 | be a reliable programming model that errs on the side of producing a |
| 292 | compiler error instead of silently producing a runtime memory problem. |
| 293 | ARC automates Objective-C objects, not malloc data, file descriptors, |
| 294 | CoreFoundation datatypes or anything else. For more details, see the |
| 295 | <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">full specification</a>. |
| 296 | |
| 297 | <h4 id="objc_instancetype">Objective-C Related Result Types / Instance |
| 298 | Types</h4> |
| 299 | Allows declaring new methods which follow the Cocoa conventions for methods |
| 300 | such as <code>init</code> which always return objects that are an instance of |
| 301 | the receiving class's type. For more details, see the |
| 302 | <a href="http://clang.llvm.org/docs/LanguageExtensions.html#objc_instancetype">language extension documentation</a>. |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 303 | |
Chandler Carruth | 52e375e | 2011-11-29 00:15:25 +0000 | [diff] [blame] | 304 | <!-- |
| 305 | This is a stub for David Chisnall to fill out. |
| 306 | |
| 307 | <h4 id="objc_gnuruntime">Improved support for the GNU Runtime</h4> |
| 308 | .... |
| 309 | --> |
| 310 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 311 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 312 | <h3 id="apichanges">Internal API Changes</h3> |
| 313 | <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = --> |
| 314 | |
Chandler Carruth | c4dbffa | 2011-11-28 18:55:47 +0000 | [diff] [blame] | 315 | These are major API changes that have happened since the 2.9 release of Clang. |
| 316 | If upgrading an external codebase that uses Clang as a library, this section |
| 317 | should help get you past the largest hurdles of upgrading. |
| 318 | |
Chandler Carruth | 7d727b7 | 2011-11-28 19:06:34 +0000 | [diff] [blame] | 319 | <h4 id="macroexpansion">Switched terminology from "instantiation" to "expansion" |
| 320 | for macros</h4> |
| 321 | A great deal of comments and code changes fell out of this, but also every API |
| 322 | relating to macros with the word "instantiation" (or some variant thereof) was |
| 323 | renamed. An incomplete list of the most note-worthy ones is here: |
| 324 | <ul> |
| 325 | <li><code>MacroInstantiation</code> became <code>MacroExpansion</code></li> |
| 326 | <li><code>SourceManager::getInstantiationLoc</code> became |
| 327 | <code>SourceManager::getExpansionLoc</code></li> |
| 328 | <li><code>SourceManager::getInstantiationRange</code> became |
| 329 | <code>SourceManager::getExpansionRange</code></li> |
| 330 | <li><code>SourceManager::getImmediateInstantiationRange</code> became |
| 331 | <code>SourceManager::getImmediateExpansionRange</code></li> |
| 332 | <li><code>SourceManager::getDecomposedInstantiationLoc</code> became |
| 333 | <code>SourceManager::getDecomposedExpansionLoc</code></li> |
| 334 | <li><code>SourceManager::getInstantiationColumnNumber</code> became |
| 335 | <code>SourceManager::getExpansionColumnNumber</code></li> |
| 336 | <li><code>SourceManager::getInstantiationLineNumber</code> became |
| 337 | <code>SourceManager::getExpansionLineNumber</code></li> |
| 338 | <!-- TODO: Make this more complete! --> |
| 339 | </ul> |
| 340 | |
Chandler Carruth | c4dbffa | 2011-11-28 18:55:47 +0000 | [diff] [blame] | 341 | <h4 id="diagnosticrename">Diagnostic class names were shuffled</h4> |
| 342 | <ul> |
| 343 | <li><code>Diagnostic</code> became <code>DiagnosticEngine</code></li> |
| 344 | <li><code>DiagnosticClient</code> became <code>DiagnosticConsumer</code></li> |
| 345 | <li><code>DiagnosticInfo</code> became <code>Diagnostic</code></li> |
| 346 | </ul> |
| 347 | Subclasses of <code>DiagnosticConsumer</code> were also then renamed to end with |
| 348 | <code>Consumer</code>. |
| 349 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 350 | <!-- ======================================================================= --> |
| 351 | <h2 id="knownproblems">Significant Known Problems</h2> |
| 352 | <!-- ======================================================================= --> |
| 353 | |
| 354 | <!-- ======================================================================= --> |
| 355 | <h2 id="additionalinfo">Additional Information</h2> |
| 356 | <!-- ======================================================================= --> |
| 357 | |
| 358 | <p>A wide variety of additional information is available on the |
| 359 | <a href="http://clang.llvm.org/">Clang web page</a>. The web page contains |
| 360 | versions of the API documentation which are up-to-date with the Subversion |
| 361 | version of the source code. You can access versions of these documents specific |
| 362 | to this release by going into the "<tt>clang/doc/</tt>" directory in the Clang |
| 363 | tree.</p> |
| 364 | |
| 365 | <p>If you have any questions or comments about Clang, please feel free to |
| 366 | contact us via the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev"> |
| 367 | mailing list</a>.</p> |
| 368 | |
Chandler Carruth | 59abf06 | 2011-11-28 22:12:44 +0000 | [diff] [blame] | 369 | |
| 370 | <!-- ======================================================================= --> |
| 371 | <!-- Likely 3.1 release notes --> |
| 372 | <!-- ======================================================================= --> |
| 373 | <!-- |
| 374 | This is just a section to hold things that have already gotten started and |
| 375 | should likely pick up proper release notes in 3.1. |
| 376 | |
| 377 | - C1X and C++11 atomics infrastructure and support |
| 378 | - CUDA support? |
| 379 | |
| 380 | --> |
| 381 | |
Chandler Carruth | c00c0c3 | 2011-11-28 07:16:19 +0000 | [diff] [blame] | 382 | </body> |
| 383 | </html> |