From d17780b20acf7fffda1158a83e497c229f1c6d41 Mon Sep 17 00:00:00 2001 From: Travis Downs Date: Wed, 22 Feb 2023 11:35:21 -0300 Subject: [PATCH] Update memory namespace comment. To include details of the set_abort_on_allocation_failure API. --- include/seastar/core/memory.hh | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/include/seastar/core/memory.hh b/include/seastar/core/memory.hh index fd4c481c6a1..77d44032bfc 100644 --- a/include/seastar/core/memory.hh +++ b/include/seastar/core/memory.hh @@ -95,9 +95,11 @@ namespace seastar { /// /// Often, the best way to debug an allocation failure is a coredump. This /// feature allows dumping core on allocation failures, containing the stack of -/// the failed allocation, by means of aborting. To enable set the -/// `abort_on_seastar_bad_alloc` configuration option or the respective command -/// line flag. +/// the failed allocation, by means of aborting. To enable this behavior, set +/// `abort_on_seastar_bad_alloc` in `reactor_options` or pass the +/// `--abort-on-seastar-bad-alloc` command line flag. Additionally, applications +/// may enable or disable this functionality globally at runtime by calling +/// `set_abort_on_allocation_failure()`. /// /// ### Dump diagnostics report ///