On Wed, 2010-03-31 at 07:57 +0200, Christian PERRIER wrote:
> Please find, for review, the debconf templates for the linux-2.6 source package.
>
> (I didn't review the package description)
>
> This is a quite important review as some of these strings are likely
> to appear during the system install. Some other will also appear
> during kernel upgrades and, I guess, particularly for lenny->squeeze
> upgrades.
Actually, they shouldn't appear during install.
[...]
> Rationale:
> --- linux-2.6.old/debian/linux-base.templates 2010-03-31 07:33:05.952958142 +0200
> +++ linux-2.6/debian/linux-base.templates 2010-03-31 07:39:33.688998875 +0200
> @@ -1,20 +1,23 @@
> Template: linux-base/disk-id-convert-auto
> Type: boolean
> Default: true
> -_Description: Update disk device ids in system configuration?
> +_Description: Update disk device IDs in system configuration?
> The new Linux kernel version provides different drivers for some
> - PATA (IDE) controllers. The names of some hard disk, CD-ROM and
> + PATA (IDE) controllers. The names of some hard disk, CD-ROM and
> tape devices may change.
> .
> - You are recommended to identify disk devices in configuration files
> + It is now recommended to identify disk devices in configuration files
> by label or UUID (unique identifier) rather than by device name,
> - which will work with both old and new kernel versions. Your system
> - configuration can be updated automatically in most cases.
> + which will work with both old and new kernel versions.
> + .
> + The system configuration can be updated automatically in most cases.
> + Please choose whether you want this action to be performed.
>
> I feel like "ID" is more appropriate than lowercas "id" as acronyms
> are generally using uppercase. However, the current practice and
> existing documentation may lead to keep "id".
'id' is short for 'identifier' and there is no reason to capitalise an
abbreviation of a single word. I believe 'ID' in capitals originally
stood for identity document, and while it is commonly used simply for
'identifier' it annoys my pedantic nature.
[...]
> Template: linux-base/disk-id-convert-plan-no-relabel
> Type: boolean
> Default: true
> -_Description: Apply these configuration changes to disk device ids?
> +#flag:translate!:3,5
> +_Description: Apply these configuration changes to disk device IDs?
This short description should match that of the previous template.
Ideally they would be the same template but AFAIK debconf has no
provision to make parts of a template conditional.
> These configuration files will be updated:
> .
> ${files}
>
> Ditto
>
>
> @@ -40,21 +44,23 @@
> ${id_map}
>
> Template: linux-base/disk-id-manual
> -Type: note
> -_Description: Please check these configuration files before rebooting
> - These configuration files still use some device names that may
> +Type: error
> +#flag:translate!:3
> +_Description: Configuration files still contain deprecated device names
> + The following configuration files still use some device names that may
> change when using the new kernel:
> .
> ${unconverted}
>
> I think that the "error" type is more likely to properly bring the
> user's attention.
This is not necessarily an error.
> Turn the synopsis from a sentence to a "title".
>
> Device names are deprecated, right? So, just say it....imho more directive.
>
>
> Template: linux-base/disk-id-manual-boot-loader
> -Type: note
> -_Description: Check the boot loader configuration before rebooting
> - The boot loader configuration for this system was not recognised. These
> +Type: error
> +_Description: Boot loader configuration check needed
> + The boot loader configuration for this system was not recognised. These
> settings in the configuration may need to be updated:
> .
> - * The root device id passed as a kernel parameter
> - * The boot device id used to install and update the boot loader
> + * The root device ID passed as a kernel parameter;
> + * The boot device ID used to install and update the boot loader.
> .
> - We recommend that you identify these devices by UUID or label, except that
> - on MIPS systems this is not supported for the root device.
> + You should identify these devices by UUID or label, with the
> + noticeable exception of the root device for MIPS systems.
> +
>
> Another note turned into "error" and a synopsis turned as a title for
> it
>
> Drop double space
>
> Add punctuation
>
> Drop the use of first person. Rewrite the last sentence that looks
> awkward to me (Germish? :-))
No, I wrote that. While it was slightly awkward, it was correct and
your change after the comma would make it ambiguous. MIPS users *must
not* use UUID or label for the root device id.
Ben.
--
Ben Hutchings
Once a job is fouled up, anything done to improve it makes it worse.
Attachment:
signature.asc
Description: This is a digitally signed message part