From: Chandler Carruth <chandlerc@gmail.com>
Date: Mon, 28 Nov 2011 18:55:47 +0000 (+0000)
Subject: Add proper text for the Diagnostic API changes.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c4dbffa863a7dbe313e2b64a56f4aac5ade268c9;p=clang

Add proper text for the Diagnostic API changes.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@145257 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/ReleaseNotes.html b/docs/ReleaseNotes.html
index b41e2eb16e..62a959e5a2 100644
--- a/docs/ReleaseNotes.html
+++ b/docs/ReleaseNotes.html
@@ -162,13 +162,6 @@ prose in a section of its own. When doing that, delete the notes.</p>
   <li>NRVO for blocks.</li>
   <li>Major improvements to the interactions between serializing and
   deserializing the AST and the preprocessor -- argiris</li>
-  <li>API -- Diagnostics API shuffle:
-    <ul>
-      <li>Diagnostic became DiagnosticEngine</li>
-      <li>DiagnosticClient became DiagnosticConsumer</li>
-      <li>DiagnosticInfo became Diagnostic</li>
-    </ul>
-  </li>
   <li>Major driver and system compatibility changes:
     <ul>
       <li>Correct support for many more hardware architecture pre-defined macros
@@ -202,6 +195,19 @@ prose in a section of its own. When doing that, delete the notes.</p>
 <h3 id="apichanges">Internal API Changes</h3>
 <!-- = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = -->
 
+These are major API changes that have happened since the 2.9 release of Clang.
+If upgrading an external codebase that uses Clang as a library, this section
+should help get you past the largest hurdles of upgrading.
+
+<h4 id="diagnosticrename">Diagnostic class names were shuffled</h4>
+<ul>
+  <li><code>Diagnostic</code> became <code>DiagnosticEngine</code></li>
+  <li><code>DiagnosticClient</code> became <code>DiagnosticConsumer</code></li>
+  <li><code>DiagnosticInfo</code> became <code>Diagnostic</code></li>
+</ul>
+Subclasses of <code>DiagnosticConsumer</code> were also then renamed to end with
+<code>Consumer</code>.
+
 <!-- ======================================================================= -->
 <h2 id="knownproblems">Significant Known Problems</h2>
 <!-- ======================================================================= -->