summaryrefslogtreecommitdiffstats
path: root/llvm/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
commit9438b1594609529e6f2ed49da9b271ac3bd474f7 (patch)
treeea423fc83936208580c146381e77b3d30d5f2bfe /llvm/docs/ReleaseNotes.rst
parentde4c9aaac5d506191e0780840ba6ebbf36dbc4f4 (diff)
downloadbcm5719-llvm-9438b1594609529e6f2ed49da9b271ac3bd474f7.tar.gz
bcm5719-llvm-9438b1594609529e6f2ed49da9b271ac3bd474f7.zip
[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 llvm-svn: 333898
Diffstat (limited to 'llvm/docs/ReleaseNotes.rst')
-rw-r--r--llvm/docs/ReleaseNotes.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/llvm/docs/ReleaseNotes.rst b/llvm/docs/ReleaseNotes.rst
index 3341d4ba3fe..a5ef08aa021 100644
--- a/llvm/docs/ReleaseNotes.rst
+++ b/llvm/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
OpenPOWER on IntegriCloud