tags 747147 +pending
thanks
Hi Justin,
On Tue, May 06, 2014 at 12:17:15AM +0100, Justin B Rye wrote:
> 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.
Thanks for your detailed analysis. I've applied the patch as is!
Cheers,
-- Guido
--
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
