glibc.malloc.check: Fix nit in documentation
authorSiddhesh Poyarekar <siddhesh@sourceware.org>
Wed, 7 Jul 2021 01:32:13 +0000 (07:02 +0530)
committerSiddhesh Poyarekar <siddhesh@sourceware.org>
Wed, 7 Jul 2021 01:32:13 +0000 (07:02 +0530)
The tunable will not work with *any* non-zero tunable value since its
list of allowed values is 0-3.  Fix the documentation to reflect that.

Reviewed-by: Adhemerval Zanella <adhemerval.zanella@linaro.org>
manual/memory.texi
manual/tunables.texi

index 28ec2e4..31ee36b 100644 (file)
@@ -1364,11 +1364,11 @@ The block was already freed.
 Another possibility to check for and guard against bugs in the use of
 @code{malloc}, @code{realloc} and @code{free} is to set the environment
 variable @code{MALLOC_CHECK_}.  When @code{MALLOC_CHECK_} is set to a
-non-zero value, a special (less efficient) implementation is used which
-is designed to be tolerant against simple errors, such as double calls
-of @code{free} with the same argument, or overruns of a single byte
-(off-by-one bugs).  Not all such errors can be protected against,
-however, and memory leaks can result.
+non-zero value less than 4, a special (less efficient) implementation is
+used which is designed to be tolerant against simple errors, such as
+double calls of @code{free} with the same argument, or overruns of a
+single byte (off-by-one bugs).  Not all such errors can be protected
+against, however, and memory leaks can result.
 
 Any detected heap corruption results in immediate termination of the
 process.
index d5d957f..ebdb562 100644 (file)
@@ -115,7 +115,7 @@ following tunables in the @code{malloc} namespace:
 This tunable supersedes the @env{MALLOC_CHECK_} environment variable and is
 identical in features.
 
-Setting this tunable to a non-zero value enables a special (less
+Setting this tunable to a non-zero value less than 4 enables a special (less
 efficient) memory allocator for the @code{malloc} family of functions that is
 designed to be tolerant against simple errors such as double calls of
 free with the same argument, or overruns of a single byte (off-by-one