Martin Eberhard Schauer wrote:
> Dear Maintainers,
> I found some copy and paste errors in the package descriptions.
> The attached patch will fix it.
It would be a pity if the other obvious problems in the package
descriptions weren't addressed at the same time.
# Package: rtai
[...]
# Description: Real Time Application Interface
The short descriptions are okay apart from the cut-and-paste errors
already mentioned. Mind you, I'm going to hyphenate "Real-Time" here;
usually below I'm standardising on "realtime" (and "userspace"), but
this seems a plausible compromise for an expansion of the initialism.
# RTAI is a realtime extension with a broad variety of services which
# make realtime programmers' lifes easier. Some of them are
Problems:
* it doesn't say what RTAI is an "extension" to!
* what could it possibly mean for an extension to have "services"?
Does it perhaps just mean "features"?
* the plural of "life" is "lives";
* "some of them are" is unidiomatic (it sounds as if you're going to
say "some of them are useful, but most of them aren't");
I would suggest something like:
The RTAI extension for the Linux kernel provides a broad variety of
facilities to make realtime programmers' lives easier, including:
# .
# choose between FIFO and RR scheduling policies on a per task basis.
# extended POSIX APIs and message queues, in kernel and user space
# semaphores can be typed as: counting, binary and resource
# a mailbox implementation
# LXRT for hard real time in user space
The formatting here is just a mess... presumably it's meant to be an
unordered list. It would read better if the items in the list were
grammatically parallel - after all, it's meant to be cataloguing
"services". Maybe:
* a choice of FIFO or RR scheduling policies (on a per-task basis);
* extended POSIX APIs and message queues, in kernel- and userspace;
* counting, binary, or resource semaphore types;
* a mailbox implementation;
* LXRT for hard realtime in userspace.
# .
# This is a metapackage that depends on the latest versions of
# the individual RTAI packages.
Nitpick: this may be true of the version of rtai in experimental, but
if we don't want the version of rtai in oldstable to have a dishonest
package description we should add the word "available".
There's nothing much wrong with any of the other package-specific
paragraphs, but I'll insert "Harvard comma" in the lists to match
d-l-e "house style".
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru rtai-3.8.1.pristine/debian/control rtai-3.8.1/debian/control
--- rtai-3.8.1.pristine/debian/control 2011-05-05 20:06:58.000000000 +0100
+++ rtai-3.8.1/debian/control 2013-01-11 13:10:33.877477189 +0000
@@ -11,32 +11,32 @@
Package: rtai
Architecture: i386 amd64 powerpc arm armel armeb
Depends: rtai-doc (>= ${source:Version}), librtai1 (>= ${source:Version}), librtai-dev (>= ${source:Version}), rtai-source (>= ${source:Version}), python-rtai, ${misc:Depends}
-Description: Real Time Application Interface
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
- This is a metapackage that depends on the latest versions of
+ This is a metapackage that depends on the latest available versions of
the individual RTAI packages.
Package: librtai1
Section: libs
Architecture: i386 amd64 powerpc arm armel armeb
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: Real Time Application Interface (module source)
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface (shared library)
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
This package contains the shared library.
@@ -44,49 +44,49 @@
Section: libdevel
Architecture: i386 amd64 powerpc arm armel armeb
Depends: librtai1 (= ${binary:Version}), ${misc:Depends}
-Description: Real Time Application Interface (module source)
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface (development files)
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
- This package contains the development files (header files, rtai-config and
+ This package contains the development files (header files, rtai-config, and
static library).
Package: rtai-source
Section: devel
Architecture: i386 amd64 powerpc arm armel armeb
Depends: make, debhelper (>= 4.0.0), python-rtai, ${misc:Depends}
-Description: Real Time Application Interface (module source)
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface (module source)
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
This package contains the patches for modifying the kernel, and sources for
- building the kernel modules, module dependent runtime tools and the testsuite.
+ building the kernel modules, module dependent runtime tools, and the testsuite.
Package: rtai-doc
Section: doc
Architecture: all
Depends: ${misc:Depends}
-Description: Real Time Application Interface (documentation)
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface (documentation)
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
This package contains the documentation.
@@ -95,14 +95,14 @@
Architecture: all
Depends: ${python:Depends}, ${misc:Depends}
XB-Python-Version: ${python:Versions}
-Description: Real Time Application Interface (documentation)
- RTAI is a realtime extension with a broad variety of services which
- make realtime programmers' lifes easier. Some of them are
- .
- choose between FIFO and RR scheduling policies on a per task basis.
- extended POSIX APIs and message queues, in kernel and user space
- semaphores can be typed as: counting, binary and resource
- a mailbox implementation
- LXRT for hard real time in user space
+Description: Real-Time Application Interface (Python bindings)
+ The RTAI extension for the Linux kernel provides a broad variety of
+ facilities to make realtime programmers' lives easier, including:
+ .
+ * a choice of FIFO or RR scheduling policies (on a per-task basis);
+ * extended POSIX APIs and message queues, in kernel- and userspace;
+ * counting, binary, or resource semaphore types;
+ * a mailbox implementation;
+ * LXRT for hard realtime in userspace.
.
This package contains the Python bindings.
