From: Mark Wielaard <mark@klomp.org>
To: "Frank Ch. Eigler" <fche@redhat.com>
Cc: Alice Zhang <alizhang@redhat.com>, elfutils-devel@sourceware.org
Subject: Re: [PATCH] debuginfod-doc: PR27950 - Remove redanduncies in man page.
Date: Fri, 30 Jul 2021 14:26:28 +0200 [thread overview]
Message-ID: <a1590ebe99d039a4f2a5bb3e5c317b2866792cd8.camel@klomp.org> (raw)
In-Reply-To: <20210729143622.GB4579@redhat.com>
Hi Frank,
On Thu, 2021-07-29 at 10:36 -0400, Frank Ch. Eigler via Elfutils-devel wrote:
> Is debuginfod-client-config.7 intended to be installed? If so it should
> > be added to notrans_dist_man7_MANS in doc/Makefile.am, [...]
>
> Yeah.
>
> > 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?
>
> man/nroff executes the .so directive during rendering, i.e., searches
> for content in the installed $MANPATH at run time. It is used on
> other fedora man pages e.g. for command aliases.
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 ?
> If we look at man1/builtins.1 and man1/bash.1, they show a bit of this
> pattern. And actually bash.1 has some conditional inclusion tricks to
> let the bash.1 page be includable as well as standalone. That same
> trick could be done within the new debuginfod-client-config.7 file.
> See the refs to ".ig zZ" and ".zZ", ".nr zZ 1" in the file that
> contains the .so directive.
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?
Thanks,
Mark
next prev parent reply other threads:[~2021-07-30 12:26 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-28 19:42 Alice Zhang
2021-07-29 14:24 ` Mark Wielaard
2021-07-29 14:36 ` Frank Ch. Eigler
2021-07-30 12:26 ` Mark Wielaard [this message]
2021-07-30 12:47 ` Frank Ch. Eigler
2021-08-04 11:33 ` Mark Wielaard
[not found] ` <CADUKC7bQJGGPYdN0CyRxvLf1xwPKJnmAszQ2SfbL8n72sVLteA@mail.gmail.com>
2021-08-05 17:07 ` Mark Wielaard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a1590ebe99d039a4f2a5bb3e5c317b2866792cd8.camel@klomp.org \
--to=mark@klomp.org \
--cc=alizhang@redhat.com \
--cc=elfutils-devel@sourceware.org \
--cc=fche@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).