From bfcfebc7b14334a6f0a53201c2d5e7b1ba7fc4f9 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Mon, 5 Jun 2017 18:53:28 +0300 Subject: [PATCH] Update current_function.adoc --- doc/current_function.adoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/current_function.adoc b/doc/current_function.adoc index c9b549b..9c96170 100644 --- a/doc/current_function.adoc +++ b/doc/current_function.adoc @@ -21,5 +21,9 @@ the (fully qualified, if possible) name of the enclosing function. If there is no enclosing function, the behavior is unspecified. Some compilers do not provide a way to obtain the name of the current enclosing -function. On such compilers, `BOOST_CURRENT_FUNCTION` expands to -`"(unknown)"`. +function. On such compilers, or when the macro `BOOST_DISABLE_CURRENT_FUNCTION` +is defined, `BOOST_CURRENT_FUNCTION` expands to `"(unknown)"`. + +`BOOST_DISABLE_CURRENT_FUNCTION` addresses a use case in which the programmer +wishes to eliminate the string literals produced by `BOOST_CURRENT_FUNCTION` from +the final executable for security reasons.