Bug 1611295

Summary: Man page scan results for gdb
Product: [Fedora] Fedora Reporter: Maryna Nalbandian <mnalband>
Component: gdbAssignee: Sergio Durigan Junior <sergiodj>
Status: CLOSED NOTABUG QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: dkutalek, jan.kratochvil, keiths, kevinb, pmuldoon, sergiodj
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-08-02 12:01:38 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1600386    
Attachments:
Description Flags
Logs none

Description Maryna Nalbandian 2018-08-02 08:30:14 UTC 
In order to improve usability of packages in Fedora, project Man Page Scan was created and its task is to provide consistency of man pages (and documentation in general). The results are now available for package maintainers to fix documentation issues.

If you need to re-run the check yourself, here is the simple process of man page check:

1. Download man-page-day from:

    https://pagure.io/ManualPageScan/blob/master/f/man-page-day.sh

2. Run the script:
    $ ./man-page-day.sh gdb
Comment 1 Maryna Nalbandian 2018-08-02 08:30:30 UTC 
Created attachment 1472440 [details]
Logs
Comment 2 Sergio Durigan Junior 2018-08-02 12:01:38 UTC 
Thanks for the report.  By looking at the log, I can see that just one error was issued.  It says:

  [ [1m[31mError(B[m ] binary /usr/bin/gdb has no man page!

That's probably because the script analyzed the "gdb" package.  However, for Fedora GDB, the gdb.1 manpage is installed by the gdb-headless package:

  [root@psique ~]# dnf provides /usr/share/man/man1/gdb.1.gz 
  gdb-headless-8.1-25.fc28.x86_64 : A GNU source-level debugger for C, C++, Fortran, Go and other languages
  Repo        : @System
  Matched from:
  Filename    : /usr/share/man/man1/gdb.1.gz

Maybe it's worth adjusting the script to identify situations where a manpage is not owned by a package but is owned by another?

Either way, I'm closing this as NOTABUG.  Feel free to reopen if you think there is still a problem.  Thanks.