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 9B2B2385F014 for ; Wed, 4 Aug 2021 11:34:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 9B2B2385F014 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 69D0730291A9; Wed, 4 Aug 2021 13:33:59 +0200 (CEST) Received: by tarox.wildebeest.org (Postfix, from userid 1000) id D37E8413CC81; Wed, 4 Aug 2021 13:33:57 +0200 (CEST) Message-ID: Subject: Re: [PATCH] debuginfod-doc: PR27950 - Remove redanduncies in man page. From: Mark Wielaard To: "Frank Ch. Eigler" Cc: Alice Zhang , elfutils-devel@sourceware.org Date: Wed, 04 Aug 2021 13:33:57 +0200 In-Reply-To: <20210730124742.GE4579@redhat.com> References: <20210728194230.298903-1-alizhang@redhat.com> <20210729143622.GB4579@redhat.com> <20210730124742.GE4579@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.3 required=5.0 tests=BAYES_00, KAM_DMARC_STATUS, SPF_HELO_NONE, SPF_PASS, 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: 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: Wed, 04 Aug 2021 11:34:02 -0000 Hi Frank, On Fri, 2021-07-30 at 08:47 -0400, Frank Ch. Eigler wrote: > > aha, ok, I understand now. This makes testing in-tree a bit more > > difficult. So the .so ./debuginfod-client-config.7 does work if you > > got > > into the doc/ subdirectory, then man ./debuginfod-find.1 does show > > the > > included chunks. But for the installed tree it should be .so man7 > > debuginfod-client-config.7 ? >=20 > It'd probably be ".so ../man7/debuginfod-client-config.7" or > something. I cannot find the canonical documentation on this, but it looks like the search path is the current directory plus MANPATH, so I am not sure .. would work. man7 (and I think it should be space, not slash) should work as long its parent is either the current directory or in the MANPATH. But all this is a little fuzzy. Maybe we need man1, man3, man7, etc subdirs in doc to make it also work in-tree (but then buildir !=3D srcdir probably is still borken). It might be fine if it only works in the install tree though. Just don't know how to write tests to double check things are fine. > > That is interesting, then we could make debuginfod-client-config.7 > > into a real man page and include only the actual contents. I am not > > completely sure I understand how this works though. I hope there is > > some man/troff documentation that explains this trick? >=20 > Documentation? Nah, let's reverse-engineer: >=20 > NROFF CPP >=20 > builtins.1: >=20 > .nr zZ 1 #define zZ 1 > .so bash.1 #include >=20 > bash.1: >=20 > .if \n(zZ=3D1 .ig zZ #ifndef zZ > [...] [...] > .zZ #else > [...] [...] OK, that looks workable (although slightly ugly). Alice, would you be able to rewrite the split man pages using the above trickery? Please do feel to ask for more info and we'll try to figure something out. Thanks, Mark