From patchwork Thu Jul 22 16:27:33 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Siddhesh Poyarekar X-Patchwork-Id: 44461 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 086683982034 for ; Thu, 22 Jul 2021 16:28:16 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 086683982034 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1626971296; bh=P3Wkhygw1Xq5sPhlaSK49dGuX7l9wI0yq8DdZPb1ExI=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=N3pLYTciF53iuYMXq9RAefXwX/emT1TKegUVdGNyLbvB2sjKuzA/3iv/6vg/hIzYj 9MaLhFBMd5JMpDtWK7qJ84bLrDFRnmBd54wG3dXoCp1wvYbxPSl/9F6qDThkMR6k/Q BIiisfaIyzQNrPRCambBcynJAezjFdnXk9JO117k= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from dog.elm.relay.mailchannels.net (dog.elm.relay.mailchannels.net [23.83.212.48]) by sourceware.org (Postfix) with ESMTPS id 334423848409 for ; Thu, 22 Jul 2021 16:27:54 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 334423848409 X-Sender-Id: dreamhost|x-authsender|siddhesh@gotplt.org Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id F2AAC542164 for ; Thu, 22 Jul 2021 16:27:52 +0000 (UTC) Received: from pdx1-sub0-mail-a10.g.dreamhost.com (100-96-11-33.trex.outbound.svc.cluster.local [100.96.11.33]) (Authenticated sender: dreamhost) by relay.mailchannels.net (Postfix) with ESMTPA id 609E2541EB6 for ; Thu, 22 Jul 2021 16:27:52 +0000 (UTC) X-Sender-Id: dreamhost|x-authsender|siddhesh@gotplt.org Received: from pdx1-sub0-mail-a10.g.dreamhost.com (pop.dreamhost.com [64.90.62.162]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384) by 100.96.11.33 (trex/6.3.3); Thu, 22 Jul 2021 16:27:52 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: dreamhost|x-authsender|siddhesh@gotplt.org X-MailChannels-Auth-Id: dreamhost X-Language-Print: 1a879f3823d4b91f_1626971272619_3377189376 X-MC-Loop-Signature: 1626971272619:3589417485 X-MC-Ingress-Time: 1626971272619 Received: from pdx1-sub0-mail-a10.g.dreamhost.com (localhost [127.0.0.1]) by pdx1-sub0-mail-a10.g.dreamhost.com (Postfix) with ESMTP id F299E7EFC3 for ; Thu, 22 Jul 2021 09:27:51 -0700 (PDT) Received: from rhbox.intra.reserved-bit.com (unknown [1.186.101.110]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) (Authenticated sender: siddhesh@gotplt.org) by pdx1-sub0-mail-a10.g.dreamhost.com (Postfix) with ESMTPSA id E95A27EFCA for ; Thu, 22 Jul 2021 09:27:49 -0700 (PDT) X-DH-BACKEND: pdx1-sub0-mail-a10 To: libc-alpha@sourceware.org Subject: [PATCH] manual: Drop the .so suffix in libc_malloc_debug description Date: Thu, 22 Jul 2021 21:57:33 +0530 Message-Id: <20210722162733.3185678-1-siddhesh@sourceware.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 X-Spam-Status: No, score=-3494.1 required=5.0 tests=BAYES_00, GIT_PATCH_0, JMQ_SPF_NEUTRAL, KAM_DMARC_NONE, KAM_DMARC_STATUS, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NEUTRAL, TXREP autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Siddhesh Poyarekar via Libc-alpha From: Siddhesh Poyarekar Reply-To: Siddhesh Poyarekar Errors-To: libc-alpha-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libc-alpha" All references to libraries in the manual are without the .so prefix, so do the same for libc_malloc_debug. Reviewed-by: Carlos O'Donell --- 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. 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