[llvm] r333898 - [ReleaseNotes] Add release note for the new LLVM_DEBUG macro.

[Nicola Zaghen via llvm-commits]

Author: nzaghen
Date: Mon Jun  4 06:55:09 2018
New Revision: 333898

URL: http://llvm.org/viewvc/llvm-project?rev=333898&view=rev
Log:
[ReleaseNotes] Add release note for the new LLVM_DEBUG macro.

This is to provide a way to migrate from the old DEBUG macro to the new one.

Differential Revision: https://reviews.llvm.org/D47528


Modified:
    llvm/trunk/docs/ReleaseNotes.rst

Modified: llvm/trunk/docs/ReleaseNotes.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/ReleaseNotes.rst?rev=333898&r1=333897&r2=333898&view=diff
==============================================================================
--- llvm/trunk/docs/ReleaseNotes.rst (original)
+++ llvm/trunk/docs/ReleaseNotes.rst Mon Jun  4 06:55:09 2018
@@ -88,6 +88,21 @@ Non-comprehensive list of changes in thi
   ``llvm/Config/llvm-config.h``.  If you used this macro, use the compiler-set
   ``_WIN32`` instead which is set exactly when ``LLVM_ON_WIN32`` used to be set.
 
+* The ``DEBUG`` macro has been renamed to ``LLVM_DEBUG``. The interface remains
+  the same.  If you used this macro you need to migrate to the new one, you can
+  do this with the following bash command:
+
+.. code-block:: bash
+
+    git grep -l 'DEBUG' | xargs perl -pi -e 's/\bDEBUG\s?\(/LLVM_DEBUG(/g'
+
+  Additionally, you can clang-format your code to make it easier to integrate
+  future changes locally.  This can be done with the following bash command:
+
+.. code-block:: bash
+
+    git diff -U0 master | ../clang/tools/clang-format/clang-format-diff.py -i -p1 -style LLVM
+
 * Note..
 
 .. NOTE