Re: please review package description of iproute.
Andreas Henriksson wrote:
> Please help review my suggested updates of the description in the
> iproute package. Also see bug #464521.
Sounds like a bug-reporter in need of good debtags.
> Here's my suggestion for updated descriptions:
>
> Package: iproute
> Description: Professional tools to control the networking in Linux kernels
^
No need for capitalisation, or for the mention of Linux kernels here
(there's no risk of kfreebsd-i386 users installing it by mistake).
Make it something like:
Description: professional tools for networking control
Description: tools for professional networking control
Description: professional networking control tools
But is this meant to imply that net-tools is for amateurs? And that
people who get paid to do a job are ipso facto superior to those who
do it on a voluntary basis? If it means "expert", it should say so.
If it means "better than the legacy net-tools suite", I'd suggest
"advanced" or "improved". If we don't know, we should just drop it:
Description: networking control tools
After all, I don't see the word "professional" anywhere on the
iproute2 homepage.
> Iproute, also knows as iproute2, is a collection of utilities for
> controlling networking and traffic control in Linux.
Where possible, keep names of packages and binaries (such as
"iproute") out of sentence-initial position where we have to decide
whether they get a capital letter.
en_GB "controlling" -> en_US "controling"; but "controlling traffic
control" is overcontrolling things anyway.
It's probably "on" or "under" Linux; but now that the old stuff
about pre-2.2 kernels and CONFIG_NETLINK has been tidied away
there's really no need for Linux to be mentioned more than once, and
the following paragraph seems the most natural place for it.
So:
The iproute suite, also knows as iproute2, is a collection of
utilities for networking and traffic control.
> These tools communicate with the Linux kernel via the (rt)netlink interface
> which makes it possible to use advanced features, which are not available
> through the legacy net-tools commands ifconfig and route.
Comma before the first "which", no comma before the second. Or
simplify:
These tools communicate with the Linux kernel via the (rt)netlink
interface, providing advanced features not available through the
legacy net-tools commands 'ifconfig' and 'route'.
(I've always wondered: is this deprecation of net-tools official, or
is it just the opinion of the iproute2 developers? If the former,
doesn't it belong in the package description for net-tools?)
> Package: iproute-doc
> Description: Professional tools to control the networking in Linux kernels
No, that was the synopsis for iproute...
Description: networking control tools - documentation
> This package contains the documentation for the iproute package.
No need for the second use of the word "package".
> Iproute2 is a collection of utilities for controlling networking
> and traffic control in Linux.
Amend as above. I've also reordered the paragraphs for consistency.
> Package: iproute-dev
> Description: Development package for iproute
Description: networking control tools - development files
> This package contains the header files and static libs for developing
> iproute additions. Iproute2 is a collection of utilities for controlling
> networking and traffic control in Linux.
> .
> You don't need this package unless doing development.
S/libs/libraries/; I imagine it's s/additions/extensions/, but I'm
not sure. Anyway, split it the same way as the others:
The iproute suite, also knows as iproute2, is a collection of
utilities for networking and traffic control.
.
This package contains the header files and static libraries for
compiling iproute extensions, and is needed only for development.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- control.old 2008-02-12 17:52:40.000000000 +0000
+++ control 2008-02-12 18:15:39.000000000 +0000
@@ -16,31 +16,29 @@
Depends: ${shlibs:Depends}
Recommends: libatm1
Suggests: iproute-doc
-Description: Professional tools to control the networking in Linux kernels
- This is `iproute', the professional set of tools to control the
- networking behavior in kernels 2.2.x and later.
+Description: networking control tools
+ The iproute suite, also knows as iproute2, is a collection of
+ utilities for networking and traffic control.
.
- At least, the options CONFIG_NETLINK and CONFIG_NETLINK_DEV (or
- CONFIG_RTNETLINK) must be compiled into the running kernel.
- .
- This package is also known as iproute2 upstream and in some
- documentation.
+ These tools communicate with the Linux kernel via the (rt)netlink
+ interface, providing advanced features not available through the
+ legacy net-tools commands 'ifconfig' and 'route'.
Package: iproute-doc
Section: doc
Architecture: all
-Description: Professional tools to control the networking in Linux kernels
- This package contains the documentation for the iproute package.
+Description: networking control tools - documentation
+ The iproute suite, also knows as iproute2, is a collection of
+ utilities for networking and traffic control.
.
- iproute is the professional set of tools to control the
- networking behavior in kernels 2.2.x and late
+ This package contains the documentation for iproute.
Package: iproute-dev
Section: libdevel
Architecture: any
-Description: Development package for iproute
- This package contains the header files and static libs for developing
- iproute additions. iproute is the professional set of tools to control the
- networking behavior in kernels 2.2.x and later.
+Description: networking control tools - development files
+ The iproute suite, also knows as iproute2, is a collection of
+ utilities for networking and traffic control.
.
- You don't need this package unless doing development.
+ This package contains the header files and static libraries for
+ compiling iproute extensions, and is needed only for development.
Source: iproute
Section: net
Priority: optional
Maintainer: Debian iproute maintainers <ah-iproute@debian.org>
Uploaders: Andreas Henriksson <andreas@fatal.se>, Alexander Wirt <formorer@debian.org>
Homepage: http://www.linux-foundation.org/en/Net:Iproute2
Vcs-Browser: http://git.debian.org/?p=collab-maint/pkg-iproute.git
Vcs-Git: git://git.debian.org/git/collab-maint/pkg-iproute.git
Standards-Version: 3.7.3
Build-Depends: texlive-latex-base, texlive-latex-recommended, libatm1-dev, bison, libdb-dev, linuxdoc-tools, linux-libc-dev, debhelper (>= 5), lynx, dpatch, flex
Package: iproute
Architecture: any
Provides: arpd
Conflicts: arpd
Depends: ${shlibs:Depends}
Recommends: libatm1
Suggests: iproute-doc
Description: networking control tools
The iproute suite, also knows as iproute2, is a collection of
utilities for networking and traffic control.
.
These tools communicate with the Linux kernel via the (rt)netlink
interface, providing advanced features not available through the
legacy net-tools commands 'ifconfig' and 'route'.
Package: iproute-doc
Section: doc
Architecture: all
Description: networking control tools - documentation
The iproute suite, also knows as iproute2, is a collection of
utilities for networking and traffic control.
.
This package contains the documentation for iproute.
Package: iproute-dev
Section: libdevel
Architecture: any
Description: networking control tools - development files
The iproute suite, also knows as iproute2, is a collection of
utilities for networking and traffic control.
.
This package contains the header files and static libraries for
compiling iproute extensions, and is needed only for development.
Reply to: