[llvm-branch-commits] [clang] 6998ecd - [NFC] [C++20] [Coroutines] Mention the side effect of a fix may bring regressions

[Tobias Hieta via llvm-branch-commits]

Author: Chuanqi Xu
Date: 2023-08-27T10:55:46+02:00
New Revision: 6998ecd330f2b028bf4678edd4f53b5489c5e6df

URL: https://github.com/llvm/llvm-project/commit/6998ecd330f2b028bf4678edd4f53b5489c5e6df
DIFF: https://github.com/llvm/llvm-project/commit/6998ecd330f2b028bf4678edd4f53b5489c5e6df.diff

LOG: [NFC] [C++20] [Coroutines] Mention the side effect of a fix may bring regressions

The fix we sent for https://github.com/llvm/llvm-project/issues/56301
may bring performance regressions. But we didn't mention it in the
ReleaseNotes so that users may get confused. e.g,
https://github.com/llvm/llvm-project/issues/64933. So this patch
mentions the possible side effect and the potential solutions in
https://github.com/llvm/llvm-project/issues/64945 to avoid
misunderstandings.

Added: 
    

Modified: 
    clang/docs/ReleaseNotes.rst

Removed: 
    


################################################################################
diff  --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index bd66a2224eccb9..b15ff0d6d20a39 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -706,6 +706,9 @@ Bug Fixes in This Version
   ``await_suspend`` could be misoptimized, including accesses to the awaiter
   object itself.
   (`#56301 <https://github.com/llvm/llvm-project/issues/56301>`_)
+  The current solution may bring performance regressions if the awaiters have
+  non-static data members. See
+  `#64945 <https://github.com/llvm/llvm-project/issues/64945>`_ for details.
 
 Bug Fixes to Compiler Builtins
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^