Package: pciutils
Version: 1:3.1.9-6
Severity: wishlist
Tags: patch
The package descriptions for the pciutils package family have a number
of minor flaws.
> Package: pciutils
> [...]
> Description: Linux PCI Utilities
There is no reason to mention Linux here; as the upstream project page
points out, these utilities work on various other Operating Systems
including Debian GNU/kFreeDSD.
Of course, that leaves you with a synopsis that basically just repeats
the package name. Just to make it less obvious, let's make
"Utilities" lowercase, and let it stand as a description:
Description: PCI utilities
Alternatively, you've got room for something like:
Description: tools for inspecting and configuring PCI devices
But that's too long to use as a basis for libpci3-udeb, so my patch
sticks to the simpler version.
Then the long description:
> This package contains various utilities for inspecting and setting of
> devices connected to the PCI bus.
That "of" is subtly unidiomatic English, and you don't "set" devices
(unless maybe they're clocks, or beartraps, or something). I would
recommend using something closer to the text on the upstream webpage,
but taking the opportunity to expand the TLA in passing:
The PCI Utilities are a collection of programs for inspecting and
manipulating configuration of devices connected to the Peripheral
Component Interconnect hardware bus.
Making this paragraph a general description of "The PCI Utilities" has
the useful side-effect that we can use it as a boilerplate intro for
all the other packages in the family (which for a start ought to make
life easier for translators).
You might add a package-specific paragraph along the lines of
.
This package provides the executables lspci, setpci, pcimodules,
and update-pciids.
but listing them just means more work if pcimodules has to be thrown
out now that modules.pcimap is gone, so my patch leaves this out.
> Package: libpci-dev
[...]
> Description: Linux PCI Utilities (development files)
Likewise:
Description: PCI utilities - development files
(Using a dash so we can reserve parentheses for the udebs.)
> This package contains the <pci/pci.h>, <pci/config.h> and <pci/header.h>
> header files, as well as the /usr/lib/libpci.a library.
Lies - these days it's /usr/lib/<multiarch-triplet>/libpci.a! But why
specify the full path for this one case anyhow? I would recommend
using (the boilerplate plus) a package-specific paragraph like this:
.
This package contains the <pci/pci.h>, <pci/config.h> and <pci/header.h>
header files, as well as the libpci.a library.
Next:
> Package: libpci3
[...]
> Description: Linux PCI Utilities (shared library)
This becomes:
Description: PCI utilities - shared library
> This package contains the libpci shared library files.
> .
> The libpci library provides portable access to configuration
> registers of devices connected to the PCI bus.
Library files, plural? I only see /lib/<triplet>/libpci.so.3.1.9 (and
a symlink).
Replace the first paragraph with the boilerplate, and tweak the second
to fit (making it less repetitive):
The PCI Utilities are a collection of programs for inspecting and
manipulating configuration of devices connected to the Peripheral
Component Interconnect hardware bus.
.
The libpci library provides portable access to configuration
registers of PCI devices.
Next:
> Package: pciutils-udeb
[...]
> Description: Linux PCI Utilities (udeb)
[...]
This just becomes a version of the full-size package with appended
mentions of udebs on the short and long descriptions. Likewise for
libpci3-udeb.
-- System Information:
Debian Release: 7.0
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 3.2.0-4-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_GB.UTF-8, LC_CTYPE=en_GB.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Versions of packages pciutils depends on:
ii libc6 2.13-38
ii libpci3 1:3.1.9-6
pciutils recommends no packages.
Versions of packages pciutils suggests:
ii bzip2 1.0.6-4
ii curl 7.26.0-1+wheezy2
ii wget 1.13.4-3
-- no debconf information
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru pciutils-3.1.9.pristine/debian/control pciutils-3.1.9/debian/control
--- pciutils-3.1.9.pristine/debian/control 2012-06-14 02:48:50.000000000 +0100
+++ pciutils-3.1.9/debian/control 2013-05-15 11:36:34.684307528 +0100
@@ -13,9 +13,10 @@
Depends: ${shlibs:Depends}, ${misc:Depends}, libpci3 (= ${binary:Version})
Multi-Arch: foreign
Suggests: bzip2, wget | curl | lynx
-Description: Linux PCI Utilities
- This package contains various utilities for inspecting and setting of
- devices connected to the PCI bus.
+Description: PCI utilities
+ The PCI Utilities are a collection of programs for inspecting and
+ manipulating configuration of devices connected to the Peripheral
+ Component Interconnect hardware bus.
Package: libpci-dev
Section: libdevel
@@ -25,9 +26,13 @@
Conflicts: pciutils-dev
Provides: pciutils-dev
Replaces: pciutils-dev
-Description: Linux PCI Utilities (development files)
+Description: PCI utilities - development files
+ The PCI Utilities are a collection of programs for inspecting and
+ manipulating configuration of devices connected to the Peripheral
+ Component Interconnect hardware bus.
+ .
This package contains the <pci/pci.h>, <pci/config.h> and <pci/header.h>
- header files, as well as the /usr/lib/libpci.a library.
+ header files, as well as the /usr/lib/<arch>/libpci.a library.
Package: libpci3
Section: libs
@@ -39,11 +44,13 @@
Conflicts: libpci2
Provides: libpci2
Replaces: libpci2
-Description: Linux PCI Utilities (shared library)
- This package contains the libpci shared library files.
+Description: PCI utilities - shared library
+ The PCI Utilities are a collection of programs for inspecting and
+ manipulating configuration of devices connected to the Peripheral
+ Component Interconnect hardware bus.
.
The libpci library provides portable access to configuration
- registers of devices connected to the PCI bus.
+ registers of PCI devices.
Package: pciutils-udeb
Package-Type: udeb
@@ -51,9 +58,10 @@
Architecture: any
Priority: standard
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: Linux PCI Utilities (udeb)
- This package contains various utilities for inspecting and setting of
- devices connected to the PCI bus.
+Description: PCI utilities (udeb)
+ The PCI Utilities are a collection of programs for inspecting and
+ manipulating configuration of devices connected to the Peripheral
+ Component Interconnect hardware bus.
.
This is a minimal version for use in debian-installer.
@@ -63,10 +71,12 @@
Architecture: any
Priority: optional
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: Linux PCI Utilities (shared library)
- This package contains the libpci shared library files.
+Description: PCI utilities - shared library (udeb)
+ The PCI Utilities are a collection of programs for inspecting and
+ manipulating configuration of devices connected to the Peripheral
+ Component Interconnect hardware bus.
.
The libpci library provides portable access to configuration
- registers of devices connected to the PCI bus.
+ registers of PCI devices.
.
This is a minimal version for use in debian-installer.
