| Message ID | 20210722162733.3185678-1-siddhesh@sourceware.org |
|---|---|
| State | New |
| Headers | show |
| Series | manual: Drop the .so suffix in libc_malloc_debug description | expand |
On 7/22/21 12:27 PM, Siddhesh Poyarekar via Libc-alpha wrote: > All references to libraries in the manual are without the .so prefix, > so do the same for libc_malloc_debug. Agreed, we tend to use either the full SONAME for a specific discussion, or just the basename of the shared object file e.g. @file{libutil} vs. @{libnss_files.so.2}. OK for 2.34. Reviewed-by: Carlos O'Donell <carlos@redhat.com> > --- > manual/memory.texi | 6 +++--- > manual/tunables.texi | 2 +- > 2 files changed, 4 insertions(+), 4 deletions(-) > > diff --git a/manual/memory.texi b/manual/memory.texi > index 69c8894602..b91c6fd70c 100644 > --- a/manual/memory.texi > +++ b/manual/memory.texi > @@ -1255,7 +1255,7 @@ environment variable @env{MALLOC_ARENA_MAX} to the desired value. > > You can ask @code{malloc} to check the consistency of dynamic memory by > using the @code{mcheck} function and preloading the malloc debug library > -@file{libc_malloc_debug.so} using the @var{LD_PRELOAD} environment variable. > +@file{libc_malloc_debug} using the @var{LD_PRELOAD} environment variable. OK. > This function is a GNU extension, declared in @file{mcheck.h}. > @pindex mcheck.h > > @@ -1368,7 +1368,7 @@ 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. Like in the case of > -@code{mcheck}, one would need to preload the @file{libc_malloc_debug.so} > +@code{mcheck}, one would need to preload the @file{libc_malloc_debug} OK. > library to enable @code{MALLOC_CHECK_} functionality. Without this > preloaded library, setting @code{MALLOC_CHECK_} will have no effect. > > @@ -1575,7 +1575,7 @@ penalties for the program if the debugging mode is not enabled. > The @code{mtrace} function provides a way to trace memory allocation > events in the program that calls it. It is disabled by default in the > library and can be enabled by preloading the debugging library > -@file{libc_malloc_debug.so} using the @code{LD_PRELOAD} environment > +@file{libc_malloc_debug} using the @code{LD_PRELOAD} environment OK. > variable. > > When the @code{mtrace} function is called it looks for an environment > diff --git a/manual/tunables.texi b/manual/tunables.texi > index e264e9150c..658547c613 100644 > --- a/manual/tunables.texi > +++ b/manual/tunables.texi > @@ -114,7 +114,7 @@ following tunables in the @code{malloc} namespace: > @deftp Tunable glibc.malloc.check > This tunable supersedes the @env{MALLOC_CHECK_} environment variable and is > identical in features. This tunable has no effect by default and needs the > -debug library @file{libc_malloc_debug.so} to be preloaded using the > +debug library @file{libc_malloc_debug} to be preloaded using the OK. > @code{LD_PRELOAD} environment variable. > > Setting this tunable to a non-zero value less than 4 enables a special (less >
diff --git a/manual/memory.texi b/manual/memory.texi index 69c8894602..b91c6fd70c 100644 --- a/manual/memory.texi +++ b/manual/memory.texi @@ -1255,7 +1255,7 @@ environment variable @env{MALLOC_ARENA_MAX} to the desired value. You can ask @code{malloc} to check the consistency of dynamic memory by using the @code{mcheck} function and preloading the malloc debug library -@file{libc_malloc_debug.so} using the @var{LD_PRELOAD} environment variable. +@file{libc_malloc_debug} using the @var{LD_PRELOAD} environment variable. This function is a GNU extension, declared in @file{mcheck.h}. @pindex mcheck.h @@ -1368,7 +1368,7 @@ 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. Like in the case of -@code{mcheck}, one would need to preload the @file{libc_malloc_debug.so} +@code{mcheck}, one would need to preload the @file{libc_malloc_debug} library to enable @code{MALLOC_CHECK_} functionality. Without this preloaded library, setting @code{MALLOC_CHECK_} will have no effect. @@ -1575,7 +1575,7 @@ penalties for the program if the debugging mode is not enabled. The @code{mtrace} function provides a way to trace memory allocation events in the program that calls it. It is disabled by default in the library and can be enabled by preloading the debugging library -@file{libc_malloc_debug.so} using the @code{LD_PRELOAD} environment +@file{libc_malloc_debug} using the @code{LD_PRELOAD} environment variable. When the @code{mtrace} function is called it looks for an environment diff --git a/manual/tunables.texi b/manual/tunables.texi index e264e9150c..658547c613 100644 --- a/manual/tunables.texi +++ b/manual/tunables.texi @@ -114,7 +114,7 @@ following tunables in the @code{malloc} namespace: @deftp Tunable glibc.malloc.check This tunable supersedes the @env{MALLOC_CHECK_} environment variable and is identical in features. This tunable has no effect by default and needs the -debug library @file{libc_malloc_debug.so} to be preloaded using the +debug library @file{libc_malloc_debug} to be preloaded using the @code{LD_PRELOAD} environment variable. Setting this tunable to a non-zero value less than 4 enables a special (less