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 1612221 - Man page scan results for passwd
Summary: Man page scan results for passwd
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: passwd
Version: 31
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
Assignee: Jiri Kucera
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: FedoraManpagescan
TreeView+ depends on / blocked
 
Reported: 2018-08-03 16:22 UTC by Maryna Nalbandian
Modified: 2019-12-20 01:13 UTC (History)
3 users (show)

Fixed In Version: passwd-0.80-7.fc31 passwd-0.80-7.fc30
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-12-07 01:50:22 UTC
Type: ---
Embargoed:

Attachments (Terms of Use)
Logs (996 bytes, text/plain)
2018-08-03 16:22 UTC, Maryna Nalbandian 		no flags Details
Log from comparison (609 bytes, text/plain)
2019-12-04 12:56 UTC, Jiri Kucera 		no flags Details
View All

Description Maryna Nalbandian 2018-08-03 16:22:00 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 passwd
Comment 1 Maryna Nalbandian 2018-08-03 16:22:18 UTC 
Created attachment 1473104 [details]
Logs
Comment 2 Jan Kurik 2018-08-14 10:37:30 UTC 
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.
Comment 3 Ben Cotton 2019-10-31 19:27:24 UTC 
This message is a reminder that Fedora 29 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 29 on 2019-11-26.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
Fedora 'version' of '29'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version' 
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora 29 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora, you are encouraged  change the 'version' to a later Fedora 
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's 
lifetime, sometimes those efforts are overtaken by events. Often a 
more recent Fedora release includes newer upstream software that fixes 
bugs or makes them obsolete.
Comment 4 Jiri Kucera 2019-12-04 12:56:37 UTC 
Created attachment 1642069 [details]
Log from comparison

Added log from comparison of output of `passwd --help` against passwd.1 manual page.
Comment 5 Jiri Kucera 2019-12-04 13:13:26 UTC 
> [ OK ] config file /etc/pam.d/passwd has man page /usr/share/man/man1/passwd.1.gz
> [ Error ] man page is in unexpected section 1. Man pages for configuration files should be in section 5

This is imho a false positive. The content of /etc/pam.d/ is described in `man 5 pam.d`.
Comment 6 Jiri Kucera 2019-12-04 13:57:39 UTC 
> 4 option(s) reported by the program ONLY:
> 	--help
> 	--keep-tokens
> 	--usage
> 	-?
> 2 option(s) reported by the man page ONLY:
> 	--keep
>       -E

Fixed in upstream commits:
- https://pagure.io/passwd/c/9f961b1dd0f3bd2bd365bc6b70597b2f89a67269
- https://pagure.io/passwd/c/05bd4d3269216eb922328af193db8e1b65afb6e1

`--help` option is so common so it is not included in SYNOPSIS section, but it should be mentioned in OPTIONS section of the manpage
`-E` is probably a false positive, because it is mentioned in-text as part of another command only ("... Use `chage -E 0 user` command instead for ...")

In addition, I found inconsistencies between field names outputted by `passwd -S` and those mentioned in manpage. The upstream commit that fixes this is https://pagure.io/passwd/c/213c1a6b8d92422d544cf9671eefe7b07209f081.
Comment 7 Jiri Kucera 2019-12-04 18:11:51 UTC 
Fix in rawhide, f31 and f30. Commit: https://src.fedoraproject.org/rpms/passwd/c/1f800c50310f216b612f5e7e3fee852a74ff96ec
Comment 8 Fedora Update System 2019-12-04 19:48:35 UTC 
FEDORA-2019-1c4b3119a7 has been submitted as an update to Fedora 30. https://bodhi.fedoraproject.org/updates/FEDORA-2019-1c4b3119a7
Comment 9 Fedora Update System 2019-12-04 19:48:36 UTC 
FEDORA-2019-8d4b43000d has been submitted as an update to Fedora 31. https://bodhi.fedoraproject.org/updates/FEDORA-2019-8d4b43000d
Comment 10 Fedora Update System 2019-12-05 01:23:47 UTC 
passwd-0.80-7.fc31 has been pushed to the Fedora 31 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2019-8d4b43000d
Comment 11 Fedora Update System 2019-12-05 02:01:14 UTC 
passwd-0.80-7.fc30 has been pushed to the Fedora 30 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2019-1c4b3119a7
Comment 12 Fedora Update System 2019-12-07 01:50:22 UTC 
passwd-0.80-7.fc31 has been pushed to the Fedora 31 stable repository. If problems still persist, please make note of it in this bug report.
Comment 13 Fedora Update System 2019-12-20 01:13:52 UTC 
passwd-0.80-7.fc30 has been pushed to the Fedora 30 stable repository. If problems still persist, please make note of it in this bug report.
Note You need to log in before you can comment on or make changes to this bug.