Note: This is a public test instance of Red Hat Bugzilla. The data contained within is a snapshot of the live data so any changes you make will not be reflected in the production Bugzilla. Email is disabled so feel free to test any aspect of the site that you want. File any problems you find or give feedback at bugzilla.redhat.com.
Bug 1612163 - Man page scan results for kde-settings
Summary: Man page scan results for kde-settings
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Fedora
Classification: Fedora
Component: kde-settings
Version: rawhide
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Rex Dieter
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:01 UTC by Maryna Nalbandian
Modified: 2018-08-06 20:24 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-06 20:24:23 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (1.65 KB, text/plain)
2018-08-03 16:01 UTC, Maryna Nalbandian 		no flags Details
View All

Description Maryna Nalbandian 2018-08-03 16:01:10 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 kde-settings
Comment 1 Maryna Nalbandian 2018-08-03 16:01:31 UTC 
Created attachment 1473047 [details]
Logs
Comment 2 Rex Dieter 2018-08-06 20:24:23 UTC 
Current version of package:
kde-settings-28.0-3.fc29.noarch

checking whether binary files have man pages:


checking whether config files have man pages:

[ Error ] config file /etc/kde/env/env.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kde/env/fedora-bookmarks.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kde/env/gpg-agent-startup.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kde/env/gtk2_rc_files.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kde/shutdown/gpg-agent-shutdown.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kde4rc has no man page! Check it's content for proper documentation
[ Error ] config file /etc/kderc has no man page! Check it's content for proper documentation
[ Error ] config file /etc/pam.d/kcheckpass has no man page! Check it's content for proper documentation
[ Error ] config file /etc/pam.d/kscreensaver has no man page! Check it's content for proper documentation
[ Error ] config file /etc/profile.d/kde.csh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/profile.d/kde.sh has no man page! Check it's content for proper documentation
[ Error ] config file /etc/xdg/kcm-about-distrorc has no man page! Check it's content for proper documentation
[ Error ] config file /etc/xdg/kdebugrc has no man page! Check it's content for proper documentation

checking for unused man pages:

[ OK ] no man pages left

now checking individual man pages:

Summary: 1x OK, 0 warnings, 13 errors


These aren't user-facing in general, not worth documenting, imho
Note You need to log in before you can comment on or make changes to this bug.