weborf(1) man page describes SIGUSR2 functionality, which does not (and never has?) existed

Bug #1875194 reported by Brian Foster on 2020-04-26
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
weborf (Ubuntu)
Undecided
Unassigned

Bug Description

The weborf(1) manual page says, when describing the --cache (-C) option,
"[...] To flush the cache (empty that directory) you must send SIGUSR2
to the process. It is advised to flush the cache on reboot (manually
or with kill) because some items might be invalid after a reboot but
weborf would not know that."

However, actually doing a `kill -SIGUSR2 <pid>' will kill the `weborf'
process; furthermore, an examination of the source code not only finds
there is no current SIGUSR2 functionality, it appears there never has
been! That man page statement was added in the original caching commit,
https://github.com/ltworf/weborf/commit/f21ee4b1ac02 ("Added --cache option"),
but no SIGUSR2 handler was added (or exists); and the (also-added) daemon
control script (`daemon/weborf' in that commit) does *not* the SIGUSR2
(if the daemon is running).

I consider this a highly confusing error in the end-user documentation;
as such, I am (obviously) presuming the daemon works correctly if the
contents of its cache dir are simply removed (even if it is running),
which is what the control script is doing.

ProblemType: Bug
DistroRelease: Ubuntu 18.04
Package: weborf 0.14-1
ProcVersionSignature: Ubuntu 4.15.0-96.97-generic 4.15.18
Uname: Linux 4.15.0-96-generic x86_64
ApportVersion: 2.20.9-0ubuntu7.14
Architecture: amd64
CurrentDesktop: KDE
Date: Sun Apr 26 15:13:00 2020
InstallationDate: Installed on 2016-10-07 (1297 days ago)
InstallationMedia: Kubuntu 16.04.1 LTS "Xenial Xerus" - Release amd64 (20160719)
SourcePackage: weborf
UpgradeStatus: Upgraded to bionic on 2018-08-18 (617 days ago)

Brian Foster (blfoster) wrote :
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers