Package: whatmaps
Version: 0.0.5
Severity: wishlist
Tags: patch
The package description has several minor flaws (but even adding them
together this is still only a wishlist bug).
# Description: Find processes mapping shared objects
I wouldn't bother mentioning this if it was the only problem, but that
synopsis is a capitalised verb phrase; the DevRef-compliant format is
a non-capitalised noun phrase, such as
Description: tool to find processes mapping shared objects
(I'm also not keen on the way it focusses on the implementation
rather than the objective, but never mind.)
# After package upgrades, processes using a ahared library need to be
# restarted to make use of that updated library (e.g. if the library got a
# security upgrade).
A typo: "ahared".
A quibble: you can't restart a process. What you restart is the
service.
The "e.g." is presented as if it's a random example of a situation
where the service won't be using the new library until restarted.
That's not right; it's the one kind of package upgrade where that
matters most.
I would suggest phrasing it as:
After package upgrades (especially security fixes), services using a
shared library need to be restarted to make use of the updated version.
# Whatmaps looks for shared objects in packages and finds running programs that
# map them, list them and allows one to restart them.
A grammar error (missing third-person-singular-present agreement): it
"listS" them ("list" makes it sound as if it's the plural programs
that list something). But why itemise the stages of *finding* and
*listing* the programs separately here anyway?
The sentence also has a rogue "and", plus some generally awkward
phrasing. For instance, "allow" isn't quite right - whatmaps doesn't
grant me permission to restart services, it offers to do that for me.
# It can be integrated with apt to automatically restart services automatically
# on security upgrades.
Repeated "automatically".
This is somewhat repetitive, once you've said that it optionally
restarts services that need it; so I would suggest merging it into the
previous paragraph, giving something like:
Whatmaps looks for shared objects provided by upgraded packages, lists any
running processes that map them, and can integrate with APT to restart
services as needed after security upgrades.
Since this package deals with the same problem as checkrestart and
needrestart but approaches it from an interestingly different angle,
it might be worth adding a couple of lines to compare and contrast...
but I'll leave that up to you.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru whatmaps-0.0.5.pristine/debian/control whatmaps-0.0.5/debian/control
--- whatmaps-0.0.5.pristine/debian/control 2014-04-18 14:13:30.000000000 +0100
+++ whatmaps-0.0.5/debian/control 2014-05-01 13:37:58.989629007 +0100
@@ -15,13 +15,10 @@
Architecture: all
Depends: ${misc:Depends}, ${python:Depends}, lsb-release,
python-apt
-Description: Find processes mapping shared objects
- After package upgrades processes using a ahared library need to be
- restarted to make use of that updated library (e.g. if the library got a
- security upgrade).
+Description: tool to find processes mapping shared objects
+ After package upgrades (especially security fixes), services using a
+ shared library need to be restarted to make use of the updated version.
.
- Whatmaps looks for shared objects in packages and finds running programs that
- map them, list them and allows one to restart them.
- .
- It can be integrated with apt to automatically restart services automatically
- on security upgrades.
+ Whatmaps looks for shared objects provided by upgraded packages, lists any
+ running processes that map them, and can integrate with APT to restart
+ services as needed after security upgrades.
