[PATCH] debuginfod-doc: PR27950 - Remove redanduncies in man page.

Mark Wielaard mark@klomp.org
Thu Jul 29 14:24:36 GMT 2021


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.
> 
> +2021-07-28  Alice Zhang <alizhang@redhat.com>
> +
> +	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


More information about the Elfutils-devel mailing list