[PATCH] debuginfod-doc: PR27950 - Remove redanduncies in man page.
Fri Jul 30 12:26:28 GMT 2021
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, [...]
> > 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
> 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?
More information about the Elfutils-devel