man page of lsof command broken

Bug #1893513 reported by Volker Wysk
22
This bug affects 3 people
Affects Status Importance Assigned to Milestone
lsof (Debian)
Fix Released
Unknown
lsof (Ubuntu)
Fix Released
Low
Unassigned
Focal
Fix Released
Low
Eric Desrochers
Groovy
Fix Released
Low
Eric Desrochers
Hirsute
Fix Released
Low
Unassigned

Bug Description

[Impact]
One cannot consult the 'lsof' manpage in various ways:
* Using CLI: man lsof
* Ubuntu Manpage: http://manpages.ubuntu.com/cgi-bin/search.py?q=lsof

You will notice the manpage is missing for F and G.

Workarounds would be:

* Use '--help' parameter
* Use a search engine to find an 'lsof' online man page.

This has been first introduced with the new upstream release of '4.93.2+dfsg-1'.

 lsof | 4.93.2+dfsg-1 | focal
 lsof | 4.93.2+dfsg-1 | groovy

[Test Case]

 == CLI ==
* On an F/G system, perform "man lsof"

It will errors out as follows:
"
man: can't open /usr/share/man/./version: No such file or directory
No manual entry for lsof
"

 == Ubuntu Manpage ==
* Browse the Ubuntu Manpage:
http://manpages.ubuntu.com/cgi-bin/search.py?q=lsof

No 'lsof' manpage is found for F/G.

[Where problem could occur]

If a problem arise, it will only affect the lsof manpage.

The fix adds a build dependency 'groff-base'[0] that is found in 'main' for all affected release above and pretty much at the same level of code base.

debian:
 groff-base | 1.22.4-5 | unstable

ubuntu:
 groff-base | 1.22.4-4build1 | focal
 groff-base | 1.22.4-5 | groovy
 groff-base | 1.22.4-5 | hirsute

[0] - https://www.gnu.org/software/groff/manual/groff.html#man

[Other info]

In theory, I would possibly wait for the next bug fixing SRU as an opportunity to merge that change, but according to the d/changelog, there is not much frequent SRU(s) done for 'lsof', so we might have to just fix 'lsof' for this particular case which can be an annoyance for certain Ubuntu users.

The package has been fixed in Debian upstream '4.93.2+dfsg-1.1' and auto-synced in Hirsute. It is now needing an SRU for F/G.

Debian bug:
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=950601

[Original Description]

When trying to view the manpage of lsof, this happens:

desktop ~ $ LANG=C man lsof
man: can't open /usr/share/man/./version: No such file or directory
No manual entry for lsof

The man page is present at /usr/share/man/man8/lsof.8.gz.

This: zless /usr/share/man/man8/lsof.8.gz
reveals that there is the line ".so ./version" at the beginning, with the file "version" not existing.

Other man pages don't seem to be affected.

ProblemType: Bug
DistroRelease: Ubuntu 20.04
Package: lsof 4.93.2+dfsg-1
ProcVersionSignature: Ubuntu 5.4.0-42.46-generic 5.4.44
Uname: Linux 5.4.0-42-generic x86_64
ApportVersion: 2.20.11-0ubuntu27.8
Architecture: amd64
CasperMD5CheckResult: skip
CurrentDesktop: ubuntu:GNOME
Date: Sat Aug 29 13:50:47 2020
InstallationDate: Installed on 2020-08-03 (26 days ago)
InstallationMedia: Ubuntu 20.04 LTS "Focal Fossa" - Release amd64 (20200423)
ProcEnviron:
 TERM=xterm
 PATH=(custom, no user)
 XDG_RUNTIME_DIR=<set>
 LANG=de_DE.UTF-8
 SHELL=/bin/bash
SourcePackage: lsof
UpgradeStatus: No upgrade log present (probably fresh install)

Revision history for this message
Volker Wysk (dost) wrote :
Revision history for this message
Volker Wysk (dost) wrote :

PS: Reinstalling the "lsof" package doesn't fix the problem.

Changed in lsof (Debian):
status: Unknown → New
Changed in lsof (Ubuntu):
importance: Undecided → Low
status: New → Triaged
Revision history for this message
Will Ross (paxswill) wrote :

Upstream (Debian) has fixed this as of about a week ago.

Eric Desrochers (slashd)
Changed in lsof (Ubuntu Hirsute):
status: Triaged → Fix Released
Eric Desrochers (slashd)
description: updated
description: updated
Changed in lsof (Ubuntu Groovy):
status: New → In Progress
Changed in lsof (Ubuntu Focal):
status: New → In Progress
assignee: nobody → Eric Desrochers (slashd)
Changed in lsof (Ubuntu Groovy):
assignee: nobody → Eric Desrochers (slashd)
importance: Undecided → Low
Changed in lsof (Ubuntu Focal):
importance: Undecided → Low
description: updated
description: updated
Eric Desrochers (slashd)
description: updated
Eric Desrochers (slashd)
description: updated
description: updated
Eric Desrochers (slashd)
description: updated
Revision history for this message
Eric Desrochers (slashd) wrote :

Fix has been uploaded in F/G and I have pinged sil2100 for SRU approval.

Note that the approval might have to wait after the holidays, but it's fine, it's low priority.

It's an annoyance for sure, but no core functionality is really broken.

- Eric

description: updated
Revision history for this message
Eric Desrochers (slashd) wrote :

debdiff for Focal

Revision history for this message
Eric Desrochers (slashd) wrote :

debdiff for Groovy

Revision history for this message
Brian Murray (brian-murray) wrote : Please test proposed package

Hello Volker, or anyone else affected,

Accepted lsof into groovy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/lsof/4.93.2+dfsg-1ubuntu0.20.10.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-groovy to verification-done-groovy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-groovy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Changed in lsof (Ubuntu Groovy):
status: In Progress → Fix Committed
tags: added: verification-needed verification-needed-groovy
Changed in lsof (Ubuntu Focal):
status: In Progress → Fix Committed
tags: added: verification-needed-focal
Revision history for this message
Brian Murray (brian-murray) wrote :

Hello Volker, or anyone else affected,

Accepted lsof into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/lsof/4.93.2+dfsg-1ubuntu0.20.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Revision history for this message
Ubuntu SRU Bot (ubuntu-sru-bot) wrote : Autopkgtest regression report (lsof/4.93.2+dfsg-1ubuntu0.20.04.1)

All autopkgtests for the newly accepted lsof (4.93.2+dfsg-1ubuntu0.20.04.1) for focal have finished running.
The following regressions have been reported in tests triggered by the package:

gvfs/1.44.1-1ubuntu1 (arm64)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/focal/update_excuses.html#lsof

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

Revision history for this message
Volker Wysk (dost) wrote :

Hi

I've tested the version of the lsof package in focal-proposed. The version is 4.93.2+dfsg-1ubuntu0.20.04.1. The "man lsof" command now works.

I'd like to "change the tag from verification-needed-focal to verification-done-focal", but I'm too lazy to figure out how to do it. :)

You could write how to do this in the "Please test proposed package" mail/post. You should also advise to do a "apt update; apt full-upgrade" before activating the -proposed respository by checking "Pre-released updates" in the developer options in the Software & Updates program on the https://wiki.ubuntu.com/Testing/EnableProposed wiki page. This would avoid confusion later.

Cheers,
Volker

Revision history for this message
Volker Wysk (dost) wrote :

Hi

How do I get back from the new version in focal-proposed to the old one in focal? Or: Will everything be okay when it goes to from focal-proposed to focal-updates in a week?

Bye
Volker

Revision history for this message
Eric Desrochers (slashd) wrote :

Thanks Volker, I'll take care of the tag change.

The focal-proposed build will be copied over to focal-updates. Assume that you currently have the pre-release package already.

The version won't change nor the package (unless regression found and other fixes needed, which is very unlikely)

tags: added: verification-done-focal
removed: verification-needed-focal
Revision history for this message
Eric Desrochers (slashd) wrote :

Juste make sure to drop the proposed pocket from your apt source, to prevent your system to install package from there.

and then 'apt-get update' to re-synchronize the sources.

tags: added: verification-done-groovy
removed: verification-needed-groovy
Revision history for this message
Eric Desrochers (slashd) wrote :

[Regressions Focal]

# Pending SRU page:
lsof
Regression in autopkgtest for gvfs (arm64): test log

# Autopkgtest gvfs [focal/arm64]
1.44.1-1ubuntu1 lsof/4.93.2+dfsg-1ubuntu0.20.04.1 2021-01-08 17:10:35 UTC 0h 13m 34s slashd fail log   artifacts   ♻

I ran the test 3 times and it fails all the time.

It also failed with the previous version just right before this SRU:

1.42.2-1ubuntu3 lsof/4.93.2+dfsg-1 2020-02-02 08:23:53 UTC 3h 03m 42s - fail log   artifacts   ♻

and this change only affect manpage, so this test failure can be ignored since we are not touching lsof code here and it the failure was also ignore back then.

- Eric

Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package lsof - 4.93.2+dfsg-1ubuntu0.20.10.1

---------------
lsof (4.93.2+dfsg-1ubuntu0.20.10.1) groovy; urgency=medium

  * d/rules:
    - Use soelim to fix unreadable manpage.
      (Closes: #950601) (LP: #1893513)

  * d/control:
    - soelim depends on groff-base.

 -- Eric Desrochers <email address hidden> Fri, 25 Dec 2020 11:57:35 -0500

Changed in lsof (Ubuntu Groovy):
status: Fix Committed → Fix Released
Revision history for this message
Brian Murray (brian-murray) wrote : Update Released

The verification of the Stable Release Update for lsof has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package lsof - 4.93.2+dfsg-1ubuntu0.20.04.1

---------------
lsof (4.93.2+dfsg-1ubuntu0.20.04.1) focal; urgency=medium

  * d/rules:
    - Use soelim to fix unreadable manpage.
      (Closes: #950601) (LP: #1893513)

  * d/control:
    - soelim depends on groff-base.

 -- Eric Desrochers <email address hidden> Fri, 25 Dec 2020 11:57:35 -0500

Changed in lsof (Ubuntu Focal):
status: Fix Committed → Fix Released
Changed in lsof (Debian):
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.