summaryrefslogtreecommitdiff
path: root/docs/ReleaseNotes.rst
diff options
context:
space:
mode:
authorNicola Zaghen <nicola.zaghen@imgtec.com>2018-06-04 13:55:09 +0000
committerNicola Zaghen <nicola.zaghen@imgtec.com>2018-06-04 13:55:09 +0000
commitfa47ca777719b86b8f3d02d1ddf9bcbb48e7cebb (patch)
tree567ed688e4ddcdbe84b699ff332ccacec3b27f1a /docs/ReleaseNotes.rst
parent49eaa4d1e03ead5dde06b91fd8312cd8498b819e (diff)
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@333898 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/ReleaseNotes.rst')
-rw-r--r--docs/ReleaseNotes.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/ReleaseNotes.rst b/docs/ReleaseNotes.rst
index 3341d4ba3fe..a5ef08aa021 100644
--- a/docs/ReleaseNotes.rst
+++ b/docs/ReleaseNotes.rst
@@ -88,6 +88,21 @@ Non-comprehensive list of changes in this release
``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