Package: svtools
Version: 0.6-2
Severity: wishlist
Tags: patch
The package description for svtools has several typos and language
errors, plus a formatting problem.
The current version is:
> Description: Utilities for daemontools and multilog
This is fine, apart from the fact that DevRef prefers an uncapitalised
first word.
> This package provides some useful utilities to maintain supervised
> services and to handle multilog log files:
This is okay, but I've ended up reshuffling the order slightly to
match other changes below. While I'm editing it I've also dropped the
redundant second "to"; and I prefer to avoid "useful utilities"
because of the distracting secondary meaning of "utility" (=
"usefulness"), so I've changed that to "convenient utilities".
> .
Now we get what ought to be a (possibly bulleted) list; unfortunately
since the paragraph isn't indented the whitespace is canonically
meaningless, and displays are allowed to reflow it, which makes a mess
of it (see e.g. http://packages.debian.org/sid/svtools).
> svdir: Find daemontools service directory.
Since the list as a whole was introduced with a colon, I would suggest
that internally they should use dashes instead (and not be punctuated
as sentences).
> svinfo: Get infos about a supervised process.
Plural "infos" is a giveaway of non-native-speaker English. There's
no need to abbreviate "information" here in the first place.
> svinitd: init.d weapper for daemontools services.
Typo: s/weapper/wrapper/. But notice that those first two were verb
phrases ("find foo", "get bar"), while this is a noun phrase
("wrapper"). Lists read more smoothly if they're consistent.
> svinitd-create: Create an init.d-script for a supervices process.
Typo: s/supervices/supervised/
> svsetup: Service setup tool for daemontools.
Verbify.
> mlcat: cat frontend for multilog files.
Surprisingly, if you do a Google image search for "cat frontend" you
get bulldozers rather than kitten noses. But it would be clearer to
stick to the approach of describing what it does (the fact that mlcat,
mlhead, and mltail are like cat, head, and tail should be obvious).
> mlhead: head frontend for multilog files.
> mltail: tail frontend for multilog files.
Why are these alphabetically sorted mlfoo utilities listed after the
alphabetically sorted svfoo utilities, anyway? (And since I change
the order I also reshuffle the introductory text to match.)
So my suggested rephrased version is:
| Description: utilities for daemontools and multilog
| This package provides some convenient utilities to handle multilog log
| files and maintain supervised services:
| .
| mlcat - output concatenated multilog files;
| mlhead - output the first part of multilog files;
| mltail - output the last part of multilog files;
| svdir - find the daemontools service directory;
| svinfo - get information about a supervised process;
| svinitd - wrap init.d commands for daemontools services;
| svinitd-create - create an init.d script for a supervised process;
| svsetup - set up a service for daemontools.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
diff -ru svtools-0.6.pristine/debian/control svtools-0.6/debian/control
--- svtools-0.6.pristine/debian/control 2011-01-09 12:10:20.000000000 +0000
+++ svtools-0.6/debian/control 2012-07-06 23:42:31.835732173 +0100
@@ -10,15 +10,15 @@
Architecture: all
Depends: ${misc:Depends}, bsdmainutils
Recommends: daemontools
-Description: Utilities for daemontools and multilog
- This package provides some useful utilities to maintain supervised
- services and to handle multilog log files:
+Description: utilities for daemontools and multilog
+ This package provides some convenient utilities to handle multilog log
+ files and maintain supervised services:
.
- svdir: Find daemontools service directory.
- svinfo: Get infos about a supervised process.
- svinitd: init.d weapper for daemontools services.
- svinitd-create: Create an init.d-script for a supervices process.
- svsetup: Service setup tool for daemontools.
- mlcat: cat frontend for multilog files.
- mlhead: head frontend for multilog files.
- mltail: tail frontend for multilog files.
+ mlcat - output concatenated multilog files;
+ mlhead - output the first part of multilog files;
+ mltail - output the last part of multilog files;
+ svdir - find the daemontools service directory;
+ svinfo - get information about a supervised process;
+ svinitd - wrap init.d commands for daemontools services;
+ svinitd-create - create an init.d script for a supervised process;
+ svsetup - set up a service for daemontools.
