[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://netselect/{templates}



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

An easy one!

>  Template: netselect/install-setuid

All looks good.  In the control file:

> -Description: Choose the fastest server automatically
> - This is netselect, an ultrafast intelligent parallelizing binary-search
> - implementation of "ping."  You give it a (possibly very long) list of
> - servers, and it chooses the fastest/closest one automatically.  It's good
> - for finding the fastest ftp.debian.org mirror, the least laggy IRC server,
> - or the best Squid neighbour.
> +Description: network servers speed probing utility
> 
> I'm not entirely happy with that pile of words but the original
> synopsis is definitely going against all recommendantions (full verb
> sentence mostly)

The plural "servers" is awkward, but then again singular "server"
would be misleading... maybe (planning ahead):

   Description: speed tester for choosing a fast network server

> + This package provides a utility allowing to perform
> + parallelized "ping" tests to distant servers.

Disallowed.

    This package provides a utility that can perform parallelized "ping"
    tests on distant servers.

> + It can process a (possibly very long) list of
> + servers, and choose the fastest/closest one automatically.

Wait, where did the Squid neighbou^Hr bit go?

    It can process a (possibly very long) list of servers, and choose the
    fastest/closest one automatically. It's useful for finding the fastest
    ftp.debian.org mirror, the least laggy IRC server, or the best Squid
    neighbor.
 
>  Package: netselect-apt
>  Architecture: all
>  Depends: wget, netselect (>= 0.3.ds1-1)
>  Enhances: apt
> -Description: Choose the fastest Debian mirror with netselect
> - netselect-apt will choose the fastest Debian mirror by downloading the full
> - mirror list and uses netselect to find the best one. netselect-apt writes a
> +Description: Debian mirror speed testing utility
> 
> I'm not entirely happy here too. Beginning with "Debian" enforces the
> use of a capital, which is discouraged. Maybe Justin will find
> something better.

There's nothing wrong with it happening to be upper case, if it's a
word that's naturally capitalised; the issue is just that short
descriptions aren't punctuated as sentences, so they don't _cause_
capitalisation on a naturally lowercase word.  But as it happens,
shuffling it to match the previous one avoids the issue:

   Description: speed tester for choosing a fast Debian mirror
 
> + This package provides a utility allowing to choose the fastest Debian mirror by downloading the full
> + mirror list and using netselect to find the fastest one.

Likewise disallowed:
    This package provides a utility that can choose the best Debian mirror
    by downloading the full mirror list and using netselect to find the
    fastest/closest one.

> + .
> + It can output a
>   sources.list(5) file that can be used with apt(8).

apt(8) is pretty useless.  Maybe we should say apt-get(8)?
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../netselect.old/debian/templates	2009-02-05 12:22:57.000000000 +0000
+++ debian/templates	2009-02-05 19:19:37.000000000 +0000
@@ -1,11 +1,11 @@
 Template: netselect/install-setuid
 Type: boolean
 Default: false
-_Description: Do you want netselect to be installed setuid root?
+_Description: Should netselect be installed setuid root?
  Netselect can be installed with the set-user-id bit set, so that it will
- run with the permissions of the 'root' user.  Since netselect needs these
- permissions to work properly, ordinary users cannot run it unless it is
+ run with the permissions of the "root" user. Since netselect needs these
+ permissions to work properly, unprivileged users cannot run it unless it is
  installed this way.
  .
- Enabling this feature may be a security risk, so it is disabled by
- default.  If in doubt, it is suggested to leave it disabled.
+ Enabling this feature may be a security risk. If in doubt, it is
+ suggested to leave it disabled.
--- ../netselect.old/debian/control	2009-02-05 12:22:57.000000000 +0000
+++ debian/control	2009-02-05 19:23:34.000000000 +0000
@@ -12,18 +12,22 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends} 
 Suggests: netselect-apt
-Description: Choose the fastest server automatically
- This is netselect, an ultrafast intelligent parallelizing binary-search
- implementation of "ping."  You give it a (possibly very long) list of
- servers, and it chooses the fastest/closest one automatically.  It's good
- for finding the fastest ftp.debian.org mirror, the least laggy IRC server,
- or the best Squid neighbour.
+Description: speed tester for choosing a fast network server
+ This package provides a utility that can perform parallelized "ping"
+ tests on distant servers.
+ .
+ It can process a (possibly very long) list of servers, and choose the
+ fastest/closest one automatically. It's useful for finding the fastest
+ ftp.debian.org mirror, the least laggy IRC server, or the best Squid
+ neighbor.
 
 Package: netselect-apt
 Architecture: all
 Depends: wget, netselect (>= 0.3.ds1-1)
 Enhances: apt
-Description: Choose the fastest Debian mirror with netselect
- netselect-apt will choose the fastest Debian mirror by downloading the full
- mirror list and uses netselect to find the best one. netselect-apt writes a
- sources.list(5) file that can be used with apt(8).
+Description: speed tester for choosing a fast Debian mirror
+ This package provides a utility that can choose the best Debian mirror
+ by downloading the full mirror list and using netselect to find the
+ fastest/closest one.
+ .
+ It can output a sources.list(5) file that can be used with apt-get(8).
Template: netselect/install-setuid
Type: boolean
Default: false
_Description: Should netselect be installed setuid root?
 Netselect can be installed with the set-user-id bit set, so that it will
 run with the permissions of the "root" user. Since netselect needs these
 permissions to work properly, unprivileged users cannot run it unless it is
 installed this way.
 .
 Enabling this feature may be a security risk. If in doubt, it is
 suggested to leave it disabled.
Source: netselect
Section: net
Priority: optional
Maintainer: Filippo Giunchedi <filippo@debian.org>
Standards-Version: 3.7.3
Build-Depends: debhelper (>= 5), po-debconf
VCS-Svn: svn://svn.debian.org/svn/collab-maint/deb-maint/netselect/trunk
VCS-Browser: http://svn.debian.org/wsvn/collab-maint/deb-maint/netselect/trunk
Homepage: http://alumnit.ca/~apenwarr/netselect/

Package: netselect
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends} 
Suggests: netselect-apt
Description: speed tester for choosing a fast network server
 This package provides a utility that can perform parallelized "ping"
 tests on distant servers.
 .
 It can process a (possibly very long) list of servers, and choose the
 fastest/closest one automatically. It's useful for finding the fastest
 ftp.debian.org mirror, the least laggy IRC server, or the best Squid
 neighbor.

Package: netselect-apt
Architecture: all
Depends: wget, netselect (>= 0.3.ds1-1)
Enhances: apt
Description: speed tester for choosing a fast Debian mirror
 This package provides a utility that can choose the best Debian mirror
 by downloading the full mirror list and using netselect to find the
 fastest/closest one.
 .
 It can output a sources.list(5) file that can be used with apt-get(8).

Reply to: