Package: module-assistant
Version: 0.11.4
Severity: wishlist
Tags: patch
The package description for m-a has several minor language problems
and one significant gap in its content.
> Package: module-assistant
> Architecture: all
As an aside: this would be fair enough if it was possible to use m-a
to build modules for non-Linux kernels, or just maintain Linux VMs on
non-Linux hosts (#602392), but unless there are plans to add such
functionality wouldn't it make sense to update this to linux-any?
[...]
> Description: tool to make module package creation easier
> The module-assistant tool (also known as m-a) helps users and
> maintainers with managing external kernel modules packaged for
> Debian. It can do:
The English here is okay, but the glaring omission is that by "kernel"
it means "Linux kernel".
> .
> - automated preparation of build environment for modules compilation
> (eg. automatical detection and installation of required kernel
> source/headers)
A couple of language issues: "eg." should be "e.g." (unless it's a
mistake for "i.e." - often it's better to switch to plain "such as" or
"that is)"; and there's no such word as "automatical" (you mean
"automatic").
Since I'm editing it I'll impose the debian-l10n-english "house style"
for bulleted lists, with asterisks and trailing semicolons.
(Inflecting an attributive noun as in "moduleS compilation" is often a
sign of non-native-speaker English, but in this case I'll assume it's
an established idiomatic exception, like "moduleS packages" below.)
> - automated module source downloads
> - configuring and keeping track of external and localy built modules
> packages
Typo: s/localy/locally/.
A minor stylistic improvement: use plain nouns ("configuration and
tracking of...") for increased parallelism between items.
> - semi-automated multiple builds for multiple kernel versions
> .
> It also contains some framework to be used by the build-scripts in the
> accompanying modules-source packages in Debian.
"Some framework" is ungrammatical, since "framework" happens to be a
count noun. You could either say "a framework" or switch to its mass
noun synonym and say "(some) infrastructure".
My suggested version:
| Description: tool to make module package creation easier
| The module-assistant tool (also known as m-a) helps users and
| maintainers with managing external Linux kernel modules packaged for
| Debian. It can do:
| .
| * automated preparation of build environment for module compilation
| (e.g. automatic detection and installation of required kernel
| source/headers);
| * automated module source downloads;
| * configuration and tracking of external and locally built modules
| packages;
| * semi-automated multiple builds for multiple kernel versions.
| .
| It also contains a framework to be used by the build-scripts in the
| accompanying modules-source packages in Debian.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
diff -ru module-assistant-0.11.4.pristine/debian/control module-assistant-0.11.4/debian/control
--- module-assistant-0.11.4.pristine/debian/control 2011-06-29 21:27:27.000000000 +0100
+++ module-assistant-0.11.4/debian/control 2012-06-26 09:20:08.071392924 +0100
@@ -13,17 +13,17 @@
Recommends: liblocale-gettext-perl
Suggests: build-essential, dialog | whiptail
Description: tool to make module package creation easier
- The module-assistant tool (also known as m-a) helps users and
- maintainers with managing external kernel modules packaged for
- Debian. It can do:
+ The module-assistant tool (also known as m-a) helps users and maintainers
+ with managing external Linux kernel modules packaged for Debian. It can
+ do:
.
- - automated preparation of build environment for modules compilation
- (eg. automatical detection and installation of required kernel
- source/headers)
- - automated module source downloads
- - configuring and keeping track of external and localy built modules
- packages
- - semi-automated multiple builds for multiple kernel versions
+ * automated preparation of build environment for module compilation
+ (e.g. automatic detection and installation of required kernel
+ source/headers);
+ * automated module source downloads;
+ * configuration and tracking of external and locally built modules
+ packages;
+ * semi-automated multiple builds for multiple kernel versions;
.
- It also contains some framework to be used by the build-scripts in the
+ It also contains some infrastructure to be used by the build-scripts in the
accompanying modules-source packages in Debian.
