From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gnu.wildebeest.org (wildebeest.demon.nl [212.238.236.112]) by sourceware.org (Postfix) with ESMTPS id 3AFC439B2854 for ; Thu, 29 Jul 2021 14:24:38 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 3AFC439B2854 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=klomp.org Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=klomp.org Received: from tarox.wildebeest.org (83-87-18-245.cable.dynamic.v4.ziggo.nl [83.87.18.245]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by gnu.wildebeest.org (Postfix) with ESMTPSA id 14F5030291A9; Thu, 29 Jul 2021 16:24:37 +0200 (CEST) Received: by tarox.wildebeest.org (Postfix, from userid 1000) id C9B30413CC73; Thu, 29 Jul 2021 16:24:36 +0200 (CEST) Message-ID: Subject: Re: [PATCH] debuginfod-doc: PR27950 - Remove redanduncies in man page. From: Mark Wielaard To: Alice Zhang , elfutils-devel@sourceware.org Date: Thu, 29 Jul 2021 16:24:36 +0200 In-Reply-To: <20210728194230.298903-1-alizhang@redhat.com> References: <20210728194230.298903-1-alizhang@redhat.com> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Mailer: Evolution 3.28.5 (3.28.5-10.el7) Mime-Version: 1.0 X-Spam-Status: No, score=-4.0 required=5.0 tests=BAYES_00, JMQ_SPF_NEUTRAL, KAM_DMARC_STATUS, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=no autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: elfutils-devel@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Elfutils-devel mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 29 Jul 2021 14:24:39 -0000 Hi Alice, On Wed, 2021-07-28 at 15:42 -0400, Alice Zhang via Elfutils-devel wrote: > Create a new file, debuginfod-client-config.7, that holds all environment > variables and cache control files related info. Get rid of repetitive > definitions in three other files, instead, those files will include the > content of new file. Any future modification related to environment > variables and cache files will only require changes in one file. >=20 > +2021-07-28 Alice Zhang > + > + PR27950 > + * debuginfod-client-config.7: New file to store all cache config > + infos. > + * debuginfod-find.1: Removed redundant occurrences of environment > + variables & cache control files. > + * debuginfod.8: Likewise. > + * debuginfod_find_debuginfo.3: Likewise. I like the idea, but I am unclear how this works. That might just be my limited knowledge of man/troff. Is debuginfod-client-config.7 intended to be installed? If so it should be added to notrans_dist_man7_MANS in doc/Makefile.am, otherwise it should be added to EXTRA_DIST to indicate it is a file part of the (source) distribution. I assume it should not be installed because it looks like a fragment of a man page. At least it doesn't seem to render correctly when displayed by man for me. If it isn't intended to be installed, maybe give it a different suffix so it isn't confused to be a standalone man page? > +.so ./debuginfod-client-config.7 So this is intended to include the fragment into the man page? That also doesn't seem to work for me. How/when does it do the lookup/inclusion? Please feel free to point me to the automake/man documentation if that explains it all. Thanks, Mark