[libcxx-commits] [libcxx] [libc++][hardening] Finish documenting hardening. (PR #92021)

Louis Dionne via libcxx-commits libcxx-commits at lists.llvm.org
Wed Jun 5 08:04:40 PDT 2024


================
@@ -29,8 +29,11 @@ modes are:
   rigour impacts performance more than fast mode: we recommend benchmarking to
   determine if that is acceptable for your program.
 - **Debug mode**, which enables all the available checks in the library,
-  including internal assertions, some of which might be very expensive. This
-  mode is intended to be used for testing, not in production.
+  including heuristic checks that might have significant performance overhead as
+  well as internal library assertions. This mode should be used in
+  non-production environments (such as test suites, CI, or local development).
+  We don’t commit to a particular level of performance in this mode and it’s
+  *not* intended to be used in production.
----------------
ldionne wrote:

I don't think we should document something like "we think we're going to do X but we're not certain". That doesn't add any clarity as far as users are concerned. If we're too unsure about what we want to do, I would recommend just not saying anything (i.e. status quo).

https://github.com/llvm/llvm-project/pull/92021


More information about the libcxx-commits mailing list