Bug 1819200 - tss2 package provides the default "man shutdown" page, but it shouldn't
Summary: tss2 package provides the default "man shutdown" page, but it shouldn't
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: tss2
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: lo1
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-03-31 13:07 UTC by Richard W.M. Jones
Modified: 2023-04-26 11:00 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-04-26 11:00:56 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Richard W.M. Jones 2020-03-31 13:07:04 UTC
Description of problem:

On a fairly vanilla Fedora 31/pre-32 machine that happens to have tss2
installed:

$ man shutdown
SHUTDOWN(1)                      User Commands                     SHUTDOWN(1)

NAME
       shutdown - Runs TPM2_Shutdown

DESCRIPTION
       shutdown

       Runs TPM2_Shutdown

       [-c    shutdown clear (default)]

       [-s    shutdown state]

shutdown 1289                     August 2018                      SHUTDOWN(1)


That's literally all it shows.  It shouldn't be the default when
you are looking for the real shutdown command.

I think probably the easiest thing to do here may be just to delete
this man page entirely in the Fedora package, since it doesn't
seem to be providing any value.

However what's interesting is this man page is generated by
help2man (which turns --help output into a rudimentary manual),
but help2man gets the wrong man page name (although the correct
file name).  The actual command is "tssshutdown".

Note these man pages are pregenerated in the tarball.  As far
as I can tell there's no way to regenerate them in the build.

Version-Release number of selected component (if applicable):

tss2-1331-2.fc31.x86_64

How reproducible:

100%

Steps to Reproduce:
1. Install tss2.
2. Type: man shutdown.

Comment 1 Richard W.M. Jones 2020-03-31 13:07:53 UTC
BTW related to this, the package BuildRequires help2man, but never
appears to run it.

Comment 2 Jerry Snitselaar 2020-05-08 19:52:56 UTC
I'm guessing help2man based it on the name of the source files, which do not have the tss prefix. The tss prefix is added in the .spec file. The latest upstream now uses autotools and configure can be passed --program-prefix.
I don't know the history of why they didn't just name the files with the prefix.


The BuildRequires should be removed. The manpages are now checked into the git repo. I've asked Ken if they can add the tss prefix into the manpages.
I'm not sure of the utility of the manpages since they are just the help from the commands, but I created a test patch that cleans it up. With the manpages updated though, the
problem still seems to exist unless you run mandb -c to wipe and rebuild the manpage databases.

An IBM engineer was supposed to take over maintaining this since their last engineer moved on, but it still hasn't happened.

Comment 3 Ben Cotton 2020-08-11 13:16:08 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 33 development cycle.
Changing version to 33.

Comment 4 Ben Cotton 2021-11-04 13:57:13 UTC
This message is a reminder that Fedora 33 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 33 on 2021-11-30.
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 '33'.

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 33 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 5 Ben Cotton 2021-11-04 14:26:35 UTC
This message is a reminder that Fedora 33 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 33 on 2021-11-30.
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 '33'.

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 33 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 6 Ben Cotton 2021-11-04 15:24:12 UTC
This message is a reminder that Fedora 33 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 33 on 2021-11-30.
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 '33'.

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 33 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 7 Ben Cotton 2021-11-30 18:51:26 UTC
Fedora 33 changed to end-of-life (EOL) status on 2021-11-30. Fedora 33 is
no longer maintained, which means that it will not receive any further
security or bug fix updates. As a result we are closing this bug.

If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
bug.

Thank you for reporting this bug and we are sorry it could not be fixed.

Comment 8 Richard W.M. Jones 2021-12-01 09:52:24 UTC
Still a problem with tss2-1.6.0-3.fc36.x86_64

Comment 9 Ben Cotton 2022-02-08 21:23:48 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 36 development cycle.
Changing version to 36.

Comment 10 Ben Cotton 2023-04-25 16:40:10 UTC
This message is a reminder that Fedora Linux 36 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora Linux 36 on 2023-05-16.
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
'version' of '36'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, change the 'version' 
to a later Fedora Linux version. Note that the version field may be hidden.
Click the "Show advanced fields" button if you do not see it.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora Linux 36 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 Linux, you are encouraged to change the 'version' to a later version
prior to this bug being closed.

Comment 11 Jerry Snitselaar 2023-04-25 17:46:20 UTC
This should be resolved with the 1.6.0 package.

Comment 12 Jerry Snitselaar 2023-04-25 17:54:35 UTC
If it comes up again though, it was an issue due to help2man populating the manpage based off a filename that doesn't include the prefix used in the end for the binary. That in combination with something the mandb code does, where even though the manpage was named /usr/share/man/man1/tssshutdown.1.gz, would cause the issue. Apparently '.TH SHUTDOWN "1" "November 2020" "shutdown 1.6" "User Commands"' was enough to get man to decide this manpage was for shutdown. I believe Ken maintains the man pages upstream manually now, so the problem shouldn't re-appear.

Comment 13 Richard W.M. Jones 2023-04-26 11:00:56 UTC
Sorry, I didn't mean to move this to Rawhide.

man shutdown does now work correctly, so closing.

(tss2-1.6.0-5.fc37.x86_64)


Note You need to log in before you can comment on or make changes to this bug.