Bug 27950 - separate common "debuginfod-client" docs into a new man page
Summary: separate common "debuginfod-client" docs into a new man page
Status: RESOLVED FIXED
Alias: None
Product: elfutils
Classification: Unclassified
Component: debuginfod (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: Alice Zhang
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-06-03 14:34 UTC by Frank Ch. Eigler
Modified: 2021-08-11 22:30 UTC (History)
2 users (show)

See Also:
Host:
Target:
Build:
Last reconfirmed:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Frank Ch. Eigler 2021-06-03 14:34:25 UTC
The information common to client library operation (DEBUGINFOD_* environment variables, cache control files, ...) is being replicated in three places in our current man pages.  We should make a new man page with just that info, and have the other three refer to it.  Or perhaps include it mechanically (at make time?).  Something to solve the manual replication efforts of this same content.
Comment 1 Frank Ch. Eigler 2021-08-11 22:30:24 UTC
merged to master: 
commit 969880e68071cefd7170a53b267379f0b32d6fbd
Author: Alice Zhang <alizhang@redhat.com>
Date:   Wed Aug 4 16:50:44 2021 -0400

    debuginfod-doc: PR27950 - Remove redanduncies in man page.
    
    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.
    
    Signed-off-by: Alice Zhang <alizhang@redhat.com>
    Signed-off-by: Frank Ch. Eigler <fche@redhat.com>