[RFR] templates://mdadm/{mdadm.templates}

Justin B Rye jbr at edlug.org.uk
Tue Jan 15 21:46:30 UTC 2008


Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

>  Template: mdadm/autostart         
[...]

> + Once the base system is booted, mdadm can start all MD arrays (RAIDs)
> + specified in /etc/mdadm/mdadm.conf, which have not yet been started. This
> + is recommended unless
> + the multiple device (MD) support is compiled in the kernel and all
> + partitions are marked as being part of MD arrays with type 0xfd (as those and only those will be
> + started automatically by the kernel).

I'd suggest:

    Once the base system has booted, mdadm can start all MD arrays (RAIDs)
    specified in /etc/mdadm/mdadm.conf which have not yet been started. This
    is recommended unless multiple device (MD) support is compiled into the
    kernel and all partitions are marked as belonging to MD arrays, with type
    0xfd (as those and only those will be started automatically by the kernel).

>  Package: mdadm
[...]
> + The mdadm tool is a program that can be used to create, manage, and monitor MD
> + (multi-disk) arrays (e.g. software RAID, multipath devices).

Shorten that "tool is a program".  And what setups *besides* RAID
and multipath mdadm can be used for?  How about: 

    The mdadm utility can be used to create, manage, and monitor MD
    (multi-disk) arrays for software RAID or multipath I/O.

("Multipath I/O" feels like better parallelism.)


Here's something I almost missed:

  Template: mdadm/autocheck
[...]
   The default, if turned on, is to run the checks on the first Sunday of every
   month at 01:06 o'clock.

"O'clock" goes with hours, not minutes.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
--- ../mdadm.old/debian/mdadm.templates	2007-12-17 20:50:18.000000000 +0000
+++ debian/mdadm.templates	2008-01-15 21:10:27.000000000 +0000
@@ -1,6 +1,7 @@
 Template: mdadm/initrdstart
 Type: string
 Default: all
+#flag:translate!:2
 _Description: MD arrays needed for the root filesystem:
  ${msg}
  .
@@ -10,8 +11,8 @@
 Template: mdadm/initrdstart_msg_intro
 Type: text
 _Description: for internal use - only the long description is needed.
- If your system has its root filesystem on an MD array (RAID), it needs to be
- started early during the boot sequence. If your root filesystem is on
+ If the system's root filesystem is located on an MD array (RAID), it needs to be
+ started early during the boot sequence. If it is located on
  a logical volume (LVM), which is on MD, all constituent arrays need to be
  started.
  .
@@ -47,9 +48,9 @@
 Template: mdadm/initrdstart_notinconf
 Type: boolean
 Default: false
-_Description: Proceed with starting arrays not listed in mdadm.conf?
- The array you have specified (${array}) is not listed in the configuration
- file ${config}. Therefore it cannot be started during boot, unless you
+_Description: Start arrays not listed in mdadm.conf?
+ The specified array (${array}) is not listed in the configuration
+ file (${config}). Therefore, it cannot be started during boot, unless you
  correct the configuration file and recreate the initial ramdisk.
  .
  Please refer to /usr/share/doc/mdadm/README.upgrading-2.5.3.gz if you intend
@@ -65,36 +66,38 @@
 Type: boolean
 Default: true
 _Description: Do you want to start MD arrays automatically?
- Once the base system has come up, mdadm can start all MD arrays (RAIDs)
- specified in /etc/mdadm/mdadm.conf, which have not yet been started. Unless
- you have compiled multiple device (MD) support into the kernel and marked all
- partitions part of MD arrays with type 0xfd (as those and only those will be
- started automatically by the kernel), this is probably what you want.
+ Once the base system has booted, mdadm can start all MD arrays (RAIDs)
+ specified in /etc/mdadm/mdadm.conf which have not yet been started. This
+ is recommended unless multiple device (MD) support is compiled into the
+ kernel and all partitions are marked as belonging to MD arrays, with type
+ 0xfd (as those and only those will be started automatically by the kernel).
 
 Template: mdadm/autocheck
 Type: boolean
 Default: true
 _Description: Should mdadm run monthly redundancy checks of the MD arrays?
- If your kernel supports it (>> 2.6.14), mdadm can periodically check the
- redundancy of your MD arrays (RAIDs). This may be a resource-intensive process,
- depending on your setup, but it could help prevent rare cases of data loss.
+ If the kernel supports it (>> 2.6.14), mdadm can periodically check the
+ redundancy of MD arrays (RAIDs). This may be a resource-intensive process,
+ depending on the local setup, but it could help prevent rare cases of data loss.
  Note that this is a read-only check unless errors are found; if errors are
  found, mdadm will try to correct them, which may result in write access to
  the media.
  .
  The default, if turned on, is to run the checks on the first Sunday of every
- month at 01:06 o'clock.
+ month at 01:06.
 
 Template: mdadm/start_daemon
 Type: boolean
 Default: true
 _Description: Do you want to start the MD monitoring daemon?
  The MD (RAID) monitor daemon sends email notifications in response to
- important MD events (such as a disk failure). You probably want to enable it.
+ important MD events (such as a disk failure).
+ .
+ It is recommended to enable this option.
 
 Template: mdadm/mail_to
 Type: string
 Default: root
 _Description: Recipient for email notifications:
  Please enter the email address of the user who should get the email
- notification for important MD events.
+ notifications for important MD events.
--- ../mdadm.old/debian/control	2007-12-17 20:50:18.000000000 +0000
+++ debian/control	2008-01-15 21:07:21.000000000 +0000
@@ -15,11 +15,11 @@
 Replaces: mdctl
 Conflicts: mdctl (<< 0.7.2), raidtools2 (<< 1.00.3-12.1), initramfs-tools (<< 0.65)
 Description: tool to administer Linux MD arrays (software RAID)
- mdadm is a program that can be used to create, manage, and monitor MD
- arrays (e.g. software RAID, multipath devices).
+ The mdadm utility can be used to create, manage, and monitor MD
+ (multi-disk) arrays for software RAID or multipath I/O.
  .
  This package automatically configures mdadm to assemble arrays during the
- system startup process. If not needed, this functionally can be disabled.
+ system startup process. If not needed, this functionality can be disabled.
 
 Package: mdadm-udeb
 Section: debian-installer
@@ -27,7 +27,7 @@
 Architecture: any
 Depends: ${shlibs:Depends}
 Description: tool to administer Linux MD arrays (software RAID)
- mdadm is a program that can be used to create, manage, and monitor MD
- arrays (e.g. software RAID, multipath devices).
+ The mdadm utility can be used to create, manage, and monitor MD
+ (multi-disk) arrays for software RAID or multipath I/O.
  .
- mdadm-udeb is a minimal package used by the debian-installer.
+ This is a minimal package used by the debian-installer.
-------------- next part --------------
Template: mdadm/initrdstart
Type: string
Default: all
#flag:translate!:2
_Description: MD arrays needed for the root filesystem:
 ${msg}
 .
 Please enter a space-separated list of devices, 'all', or 'none'. You may
 omit the leading '/dev/' and just enter e.g. "md0 md1", or "md/1 md/d0".

Template: mdadm/initrdstart_msg_intro
Type: text
_Description: for internal use - only the long description is needed.
 If the system's root filesystem is located on an MD array (RAID), it needs to be
 started early during the boot sequence. If it is located on
 a logical volume (LVM), which is on MD, all constituent arrays need to be
 started.
 .
 If you know exactly which arrays are needed to bring up the root filesystem,
 and you want to postpone starting all other arrays to a later point in the
 boot sequence, enter the arrays to start here. Alternatively, enter 'all' to
 simply start all available arrays.
 .
 If you do not need or want to start any arrays for the root filesystem, leave
 the answer blank (or enter 'none'). This may be the case if you are using
 kernel autostart or do not need any arrays to boot.

Template: mdadm/initrdstart_msg_errexist
Type: text
_Description:
 An error occurred: device node does not exist

Template: mdadm/initrdstart_msg_errblock
Type: text
_Description:
 An error occurred: not a block device

Template: mdadm/initrdstart_msg_errmd
Type: text
_Description:
 An error occurred: not an MD array

Template: mdadm/initrdstart_msg_errconf
Type: text
_Description:
 An error occurred: array not listed in mdadm.conf file

Template: mdadm/initrdstart_notinconf
Type: boolean
Default: false
_Description: Start arrays not listed in mdadm.conf?
 The specified array (${array}) is not listed in the configuration
 file (${config}). Therefore, it cannot be started during boot, unless you
 correct the configuration file and recreate the initial ramdisk.
 .
 Please refer to /usr/share/doc/mdadm/README.upgrading-2.5.3.gz if you intend
 to continue.
 .
 This warning is only relevant if you need arrays to be started from the
 initial ramdisk to be able to boot. If you use kernel autostarting, or do not
 need any arrays to be started as early as the initial ramdisk is loaded, you
 can simply continue. Alternatively, choose not to continue and enter 'none'
 when prompted which arrays to start from the initial ramdisk.

Template: mdadm/autostart
Type: boolean
Default: true
_Description: Do you want to start MD arrays automatically?
 Once the base system has booted, mdadm can start all MD arrays (RAIDs)
 specified in /etc/mdadm/mdadm.conf which have not yet been started. This
 is recommended unless multiple device (MD) support is compiled into the
 kernel and all partitions are marked as belonging to MD arrays, with type
 0xfd (as those and only those will be started automatically by the kernel).

Template: mdadm/autocheck
Type: boolean
Default: true
_Description: Should mdadm run monthly redundancy checks of the MD arrays?
 If the kernel supports it (>> 2.6.14), mdadm can periodically check the
 redundancy of MD arrays (RAIDs). This may be a resource-intensive process,
 depending on the local setup, but it could help prevent rare cases of data loss.
 Note that this is a read-only check unless errors are found; if errors are
 found, mdadm will try to correct them, which may result in write access to
 the media.
 .
 The default, if turned on, is to run the checks on the first Sunday of every
 month at 01:06.

Template: mdadm/start_daemon
Type: boolean
Default: true
_Description: Do you want to start the MD monitoring daemon?
 The MD (RAID) monitor daemon sends email notifications in response to
 important MD events (such as a disk failure).
 .
 It is recommended to enable this option.

Template: mdadm/mail_to
Type: string
Default: root
_Description: Recipient for email notifications:
 Please enter the email address of the user who should get the email
 notifications for important MD events.
-------------- next part --------------
Source: mdadm
Section: admin
Priority: optional
Maintainer: Debian mdadm maintainers <pkg-mdadm-devel at lists.alioth.debian.org>
Uploaders: martin f. krafft <madduck at debian.org>, Mario Joussen <joussen at debian.org>
Build-Depends: debhelper (>= 5), po-debconf, groff-base, docbook-to-man
Standards-Version: 3.7.2
XS-Vcs-Git: git://git.debian.org/git/pkg-mdadm/mdadm.git
XS-Vcs-Browser: http://git.debian.org/?p=pkg-mdadm/mdadm.git

Package: mdadm
Architecture: any
Depends: ${shlibs:Depends}, udev | makedev, ${misc:Depends}, lsb-base (>= 3.1-6), debconf (>= 1.4.72)
Recommends: mail-transport-agent, module-init-tools
Replaces: mdctl
Conflicts: mdctl (<< 0.7.2), raidtools2 (<< 1.00.3-12.1), initramfs-tools (<< 0.65)
Description: tool to administer Linux MD arrays (software RAID)
 The mdadm utility can be used to create, manage, and monitor MD
 (multi-disk) arrays for software RAID or multipath I/O.
 .
 This package automatically configures mdadm to assemble arrays during the
 system startup process. If not needed, this functionality can be disabled.

Package: mdadm-udeb
Section: debian-installer
XC-Package-Type: udeb
Architecture: any
Depends: ${shlibs:Depends}
Description: tool to administer Linux MD arrays (software RAID)
 The mdadm utility can be used to create, manage, and monitor MD
 (multi-disk) arrays for software RAID or multipath I/O.
 .
 This is a minimal package used by the debian-installer.


More information about the pkg-mdadm-devel mailing list