[PATCH] D114602: [clang-tidy][docs][NFC] Improve documentation of bugprone-unhandled-exception-at-new

[Balázs Kéri via Phabricator via cfe-commits]

balazske updated this revision to Diff 390048.
balazske added a comment.

Apply of review comments.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D114602/new/

https://reviews.llvm.org/D114602

Files:
  clang-tools-extra/docs/clang-tidy/checks/bugprone-unhandled-exception-at-new.rst


Index: clang-tools-extra/docs/clang-tidy/checks/bugprone-unhandled-exception-at-new.rst
===================================================================
--- clang-tools-extra/docs/clang-tidy/checks/bugprone-unhandled-exception-at-new.rst
+++ clang-tools-extra/docs/clang-tidy/checks/bugprone-unhandled-exception-at-new.rst
@@ -5,21 +5,51 @@
 
 Finds calls to ``new`` with missing exception handler for ``std::bad_alloc``.
 
+Calls to ``new`` may throw exceptions of type ``std::bad_alloc`` that should
+be handled. Alternatively, the nonthrowing form of ``new`` can be
+used. The check verifies that the exception is handled in the function
+that calls ``new``.
+
+If a nonthrowing version is used or the exception is allowed to propagate out
+of the function no warning is generated.
+
+The exception handler is checked if it catches the ``std::bad_alloc``, or
+``std::exception`` exception types, or all exceptions (catch-all).
+The check assumes that any user-defined ``operator new`` is either
+``noexcept`` or may throw an exception of type ``std::bad_alloc`` (or one
+derived from it). Other exception class types are not taken into account.
+
 .. code-block:: c++
 
   int *f() noexcept {
-    int *p = new int[1000];
+    int *p = new int[1000]; // warning: missing exception handler for allocation failure at 'new'
+    // ...
+    return p;
+  }
+
+.. code-block:: c++
+
+  int *f1() { // not 'noexcept'
+    int *p = new int[1000]; // no warning: exception can be handled outside
+                            // of this function
+    // ...
+    return p;
+  }
+
+  int *f2() noexcept {
+    try {
+      int *p = new int[1000]; // no warning: exception is handled
+      // ...
+      return p;
+    } catch (std::bad_alloc &) {
+      // ...
+    }
+    // ...
+  }
+
+  int *f3() noexcept {
+    int *p = new (std::nothrow) int[1000]; // no warning: "nothrow" is used
     // ...
     return p;
   }
 
-Calls to ``new`` can throw exceptions of type ``std::bad_alloc`` that should
-be handled by the code. Alternatively, the nonthrowing form of ``new`` can be
-used. The check verifies that the exception is handled in the function
-that calls ``new``, unless a nonthrowing version is used or the exception
-is allowed to propagate out of the function (exception handler is checked for
-types ``std::bad_alloc``, ``std::exception``, and catch-all handler).
-The check assumes that any user-defined ``operator new`` is either
-``noexcept`` or may throw an exception of type ``std::bad_alloc`` (or derived
-from it). Other exception types or exceptions occurring in the object's
-constructor are not taken into account.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D114602.390048.patch
Type: text/x-patch
Size: 2634 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20211126/b52b593c/attachment-0001.bin>