Re: [RFR] templates://setserial/{templates}
Christian Perrier wrote:
> Your review should be sent as an answer to this mail.
> Template: setserial/autosave
[...]
> + The /etc/serial.conf file contains the serial ports configuration
> + parameters. These parameters may be configured automatically now
> + or manually by editing the file.
We've lost the recommendation that it should be done automatically;
in fact starting with the location of the configuration file seems
to imply that users are expected to want to edit it.
And it's "serial port_ configuration parameters", because nouns used
as modifiers in noun-piles don't (usually) inflect for number.
And it's "the file /etc/serial.conf", because you're telling us its
name, not using the name to help identify it (it's "the file
/usr/share/foo/bar/baz.quux", "the directory /etc/foo/rules.d",
telling us where to find them; but "the README.Debian file", "the
rules.d directory", treating their names as transparently
meaningful labels).
So how about:
It is recommended that the serial port parameters should be configured
automatically. It is also possible to configure them manually by editing
the file /etc/serial.conf.
> + PCMCIA serial-type devices should be configured along with pcmcia-cs.
Isn't that plain "with pcmcia-cs" (or maybe "by/by means of")? In
fact nowadays pcmcia-cs is itself an obsolete transition package to
pcmciautils. We're assuming the setserial/pcmcia incompatibility
still applies...
> + For more details, please read the /usr/share/doc/setserial/README.Debian.gz
> + file.
I suppose "the file /usr/share/doc/foo/README" and "the
/usr/share/doc/foo/README file" work either way, but I like this
issue-avoiding phrasing anyway:
PCMCIA serial-type devices should be configured with pcmciautils. See
/usr/share/doc/setserial/README.Debian.gz for details.
> Template: setserial/autosave-types
[...]
> +_Description: Type of automatic serial port configuration:
> + Setserial allows saving the current serial configuration in various ways:
> + .
> + autosave once : save only once, now;
> + manual : never save the configuration automatically;
> + autosave always: save on every system shutdown;
> + kernel : do not use the serial.conf file and use the kernel settings
> + at bootup.
First, a round of applause.
We should probably preserve some hint of the "DANGEROUS" element:
autosave always: save on every system shutdown (risks overwriting the
serial.conf file with errors);
Oh, and I don't like the word "bootup", but I can't think why, so I
won't change it.
> Template: setserial/update-modules-failed
[...]
> + This process filed. This can be caused by a non-standard module
s/filed/failed/; and make it a "may", since it's a guess at what's
true rather than a statement of what's possible.
> Package: setserial
[...]
> -Description: controls configuration of serial ports
> - Set and/or report the configuration information associated with
> - a serial port. This information includes what I/O port and which IRQ
> - a particular serial port is using.
> +Description: serial port parameters configuration
s/parameters/parameter/. But setserial isn't the configuration,
it's the configurator, or configuration utility, or something. How
about:
Description: serial port configuration system
> + This package provides an utility to set and/or report the configuration information associated with
> + serial ports, such as I/O port and IRQ.
A yutility.
The problem with "serial ports" (plural) is that the following "such
as" makes me anticipate a list of example serial ports ("such as
modems, ancient mice...)". Besides, it's the individual serial port
that gets a particular IRQ.
This package provides a utility to set and/or report the configuration
information associated with a serial port, such as I/O port and IRQ.
Or we could go for "the configuration information (such as I/O ports
and IRQs) associated with serial ports".
> + For instance, by default, only COM1 to COM4 are configured by the kernel,
> + using IRQ 3 and 4. This package helps setting up additional serial
> + ports or standard ports with differently mapped IRQ.
s/IRQ/IRQs/ both times.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- ../setserial.old/debian/templates 2007-02-18 17:13:11.000000000 +0000
+++ debian/templates 2008-01-19 16:14:42.000000000 +0000
@@ -1,45 +1,31 @@
Template: setserial/autosave
Type: boolean
Default: true
-_Description: Do you want the automatic serial port configuration?
- All releases of setserial since 2.15 use the file /etc/serial.conf to
- configure the serial ports. You can edit it to your own likings, or use
- the automatic serial port configuration, which is the recommended way of
- doing it.
- .
- Attention PCMCIA users - pcmcia-cs has its own configuration for PC Card
- serial-type devices, which is not compatible with setserial. In case of
- problems, please read the /usr/share/doc/setserial/README.Debian.gz file.
+_Description: Automatically configure the serial port parameters?
+ It is recommended that the serial port parameters should be configured
+ automatically. It is also possible to configure them manually by editing
+ the file /etc/serial.conf.
+ .
+ PCMCIA serial-type devices should be configured with pcmciautils. See
+ /usr/share/doc/setserial/README.Debian.gz for details.
Template: setserial/autosave-types
Type: select
-_Choices: autosave once, manual, autosave always, kernel
+__Choices: autosave once, manual, autosave always, kernel
Default: autosave once
-_Description: Type of automatic serial port configuration to use?
- Setserial contains the ability to save your current serial configurations,
- but you have to decide the method which setserial is to use.
- .
- autosave once - this saves your serial configuration the first time you
- select this option, using kernel information. From this point on this
- information is never changed automatically again. If you want the
- configuration to change you have to edit serial.conf by hand. This is the
- default and is good in almost all cases.
- .
- manual - control serial.conf yourself right from the start. Good for
- experts who like to get their hands dirty, but autosave-once is probably
- still better.
- .
- autosave always - save the serial configuration on every system shutdown,
- and reload the saved state when you reboot. Good if you change your serial
- configuration a lot, but DANGEROUS as rebooting a system with "errors" can
- result in the complete loss of your serial configuration!
- .
- kernel - blank the serial.conf file and use the kernel settings on bootup.
- This may be useful for standard situations or where setserial has become
- confused.
+_Description: Type of automatic serial port configuration:
+ Setserial allows saving the current serial configuration in various ways:
+ .
+ autosave once : save only once, now;
+ manual : never save the configuration automatically;
+ autosave always: save on every system shutdown (risks overwriting the
+ serial.conf file with errors);
+ kernel : do not use the serial.conf file and use the kernel settings
+ at bootup.
Template: setserial/rc-boot-file-renamed
Type: note
+# obsolete, should be removed, not reviewed
_Description: Please read documentation on old 0setserial entries
You have an old-style 0setserial entry. The configuration mechanism has
changed completely after setserial release 2.14.
@@ -51,6 +37,7 @@
Template: setserial/rc-boot-file-removed
Type: note
+# obsolete, should be removed, not reviewed
_Description: New method of bootup initialization used
You have an old-style 0setserial entry. The configuration mechanism has
changed completely after setserial release 2.14.
@@ -59,11 +46,12 @@
/etc/init.d/setserial file is used instead.
Template: setserial/update-modules-failed
-Type: note
-_Description: update-modules failed!
- WARNING: setserial tried to install the module management code to support
- the serial.o module being loaded and unloaded dynamically by kerneld (or
- its equivalent). However, update-modules failed to allow its installation.
- .
- There may be something non-standard about your module configuration. You
- should try running /sbin/update-modules on your own.
+Type: error
+_Description: Error during update-modules configuration for setserial
+ The setserial configuration process tried to install the module
+ management code to support the serial.o module being loaded and
+ unloaded dynamically by the kernel module loader.
+ .
+ This process failed. This may be caused by a non-standard module
+ configuration and should be solved manually by running
+ '/sbin/update-modules'.
--- ../setserial.old/debian/control 2007-02-18 17:13:11.000000000 +0000
+++ debian/control 2008-01-19 15:51:59.000000000 +0000
@@ -9,17 +9,10 @@
Package: setserial
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: controls configuration of serial ports
- Set and/or report the configuration information associated with
- a serial port. This information includes what I/O port and which IRQ
- a particular serial port is using.
+Description: serial port configuration system
+ This package provides a utility to set and/or report the configuration
+ information associated with a serial port, such as I/O port and IRQ.
.
- This version has a completely new approach to configuration, so if you
- have a setup other than the standard ttyS0 and 1, you will have to get
- your hands dirty.
- .
- By default, only COM1-4 are configured by the kernel, using IRQ 3 and 4.
- If you have other serial ports (such as an AST Fourport card), or
- if you have mapped the IRQs differently (perhaps COM3 and 4 to other
- IRQs to allow concurrent access with COM1 and 2) then you must have this
- package.
+ For instance, by default, only COM1 to COM4 are configured by the kernel,
+ using IRQs 3 and 4. This package helps setting up additional serial
+ ports or standard ports with differently mapped IRQs.
Template: setserial/autosave
Type: boolean
Default: true
_Description: Automatically configure the serial port parameters?
It is recommended that the serial port parameters should be configured
automatically. It is also possible to configure them manually by editing
the file /etc/serial.conf.
.
PCMCIA serial-type devices should be configured with pcmciautils. See
/usr/share/doc/setserial/README.Debian.gz for details.
Template: setserial/autosave-types
Type: select
__Choices: autosave once, manual, autosave always, kernel
Default: autosave once
_Description: Type of automatic serial port configuration:
Setserial allows saving the current serial configuration in various ways:
.
autosave once : save only once, now;
manual : never save the configuration automatically;
autosave always: save on every system shutdown (risks overwriting the
serial.conf file with errors);
kernel : do not use the serial.conf file and use the kernel settings
at bootup.
Template: setserial/rc-boot-file-renamed
Type: note
# obsolete, should be removed, not reviewed
_Description: Please read documentation on old 0setserial entries
You have an old-style 0setserial entry. The configuration mechanism has
changed completely after setserial release 2.14.
.
Your old /etc/rc.boot/0setserial file was just renamed to
0setserial.pre-2.15.
.
Read /usr/share/doc/setserial/README.Debian.gz file for more information.
Template: setserial/rc-boot-file-removed
Type: note
# obsolete, should be removed, not reviewed
_Description: New method of bootup initialization used
You have an old-style 0setserial entry. The configuration mechanism has
changed completely after setserial release 2.14.
.
Your old /etc/rc.boot/0setserial file was removed. The
/etc/init.d/setserial file is used instead.
Template: setserial/update-modules-failed
Type: error
_Description: Error during update-modules configuration for setserial
The setserial configuration process tried to install the module
management code to support the serial.o module being loaded and
unloaded dynamically by the kernel module loader.
.
This process failed. This may be caused by a non-standard module
configuration and should be solved manually by running
'/sbin/update-modules'.
Source: setserial
Section: comm
Priority: extra
Maintainer: Jonas Genannt <jonas.genannt@capi2name.de>
Uploaders: Ola Lundqvist <opal@debian.org>
Build-Depends: debhelper (>= 4.1.16), autotools-dev, po-debconf
Standards-Version: 3.7.2
Package: setserial
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: serial port configuration system
This package provides a utility to set and/or report the configuration
information associated with a serial port, such as I/O port and IRQ.
.
For instance, by default, only COM1 to COM4 are configured by the kernel,
using IRQs 3 and 4. This package helps setting up additional serial
ports or standard ports with differently mapped IRQs.
Reply to: