Please find, for review, the debconf templates and packages descriptions for the setserial source package.
This review will last from Saturday, January 19, 2008 to Tuesday, January 29, 2008.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.
When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.
Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- ../setserial.old/debian/templates 2008-01-14 08:36:13.457408009 +0100
+++ debian/templates 2008-01-15 07:36:30.408837930 +0100
@@ -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?
Typical unpersonnalization
+ The /etc/serial.conf file contains the serial ports configuration
+ parameters. These parameters may be configured automatically now
+ or manually by editing the file.
+ .
+ PCMCIA serial-type devices should be configured along with pcmcia-cs.
+ For more details, please read the /usr/share/doc/setserial/README.Debian.gz
+ file.
Remove references to really old versions of setserial.
Reword sentences to be more neutral
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 ;
+ kernel : do not use the serial.conf file and use the kernel settings
+ at bootup.
That template was awfully too long. A multiselect template needs a
quite short description to fit in one screen which is always
preferred.
So, I did choose to make explanations very scarce and, for instance,
do not say who this or that choice is "good" for. Just be factual and
shortly explain what are the consequences of each choice.
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.
I reported this as obsolete in another BR
@@ -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.
Ditto
@@ -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 filed. This can be caused by a non-standard module
+ configuration and should be solved manually by running
+ '/sbin/update-modules'.
Remove the ugly exclamation mark sentence and be factual. Also explain
during what step the "update-modules" did fail.
--- ../setserial.old/debian/control 2008-01-14 08:36:13.457408009 +0100
+++ debian/control 2008-01-17 07:28:45.161536440 +0100
@@ -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 parameters configuration
+ This package provides an utility to set and/or report the configuration information associated with
+ serial ports, such as I/O port and IRQ.
Synopsis: do not make a sentence
Long description: make complete sentences.
.
- 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.
- .
Drop this. We're in 21st century.
- 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 IRQ 3 and 4. This package helps setting up additional serial
+ ports or standard ports with differently mapped IRQ.
Setting extra COM ports is only one of the actions that can be
performed by setserial, so make it clear this is an example.
Remove the example about "AST Fourports", which is very likely to be
considered old stuff now.
--
Template: setserial/autosave
Type: boolean
Default: true
_Description: Automatically configure the serial port parameters?
The /etc/serial.conf file contains the serial ports configuration
parameters. These parameters may be configured automatically now
or manually by editing the file.
.
PCMCIA serial-type devices should be configured along with pcmcia-cs.
For more details, please read the /usr/share/doc/setserial/README.Debian.gz
file.
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;
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 filed. This can be caused by a non-standard module
configuration and should be solved manually by running
'/sbin/update-modules'.
--- setserial.old/debian/templates 2008-01-14 08:36:13.457408009 +0100
+++ setserial/debian/templates 2008-01-19 14:13:10.304401441 +0100
@@ -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?
+ The /etc/serial.conf file contains the serial ports configuration
+ parameters. These parameters may be configured automatically now
+ or manually by editing the file.
+ .
+ PCMCIA serial-type devices should be configured along with pcmcia-cs.
+ For more details, please read the /usr/share/doc/setserial/README.Debian.gz
+ file.
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;
+ 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 filed. This can be caused by a non-standard module
+ configuration and should be solved manually by running
+ '/sbin/update-modules'.
--- setserial.old/debian/control 2008-01-14 08:36:13.457408009 +0100
+++ setserial/debian/control 2008-01-19 14:14:49.256424359 +0100
@@ -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 parameters configuration
+ This package provides an utility to set and/or report the configuration information associated with
+ serial ports, 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 IRQ 3 and 4. This package helps setting up additional serial
+ ports or standard ports with differently mapped IRQ.
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 parameters configuration
This package provides an utility to set and/or report the configuration information associated with
serial ports, such as I/O port and IRQ.
.
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.
Attachment:
signature.asc
Description: Digital signature