[Pkg-zfsonlinux-devel] Ask for review of Debconf templates

[Justin B Rye]

Aron Xu wrote:
> I would like to ask for your help on reviewing the Debconf templates
> for zfs-linux source package. The current draft of templates are here:
> http://anonscm.debian.org/gitweb/?p=pkg-zfsonlinux/zfs.git;a=blob;f=debian/zfs-dkms.templates
> 
> The two questions are asked only if postinst script detects the
> running kernel is 32-bit (stop-build-for-32bit-kernel), or the script
> cannot determine whether the kernel is 32-bit or 64-bit
> (stop-build-for-unknown-kernel). Rational is that upstream effort on
> proper 32-bit kernel support is still ongoing and quite far from being
> as stable as on 64-bit kernel, we'd like to gently ask our users stop
> here but don't get in the way if they insist.

Okay, putting it inline:
> Template: zfs-dkms/stop-build-for-32bit-kernel
> Type: boolean
> Default: true
> Description:  Stop the build since your running kernel is 32-bit?
              ^
(Surplus space)

There's probably a better way of phrasing that.  Does it makes sense
to describe the build as having already started at this point?  Maybe
it should say

  Description: Abort building ZFS on a 32-bit kernel?

>  You are attempting to build ZFS on a 32-bit kernel.

Rehouse the bit I dropped from the short description:

   You are attempting to build ZFS on a machine running a 32-bit kernel.

>  .
>  At the moment ZFS will build in a 32-bit environment but it is
>  UNSUPPORTED and will likely cause instability and may lead to data
>  corruption. You are strongly encouraged to use ZFS on a 64-bit kernel.

I doubt this is likely to change before teatime, so drop "at the
moment".  And probably no need to shout.

>  .
>  Keep in mind that if you decide to continue using ZFS on a 32-bit
>  kernel then it is at your own risk.

Since I've lengthened the first sentence I'd like to try to squeeze
the second paragraph a bit:

   You are attempting to build ZFS against a 32-bit running kernel.
   .
   Although possible, this is unsupported and likely to cause instability
   leading to possible data corruption. You are strongly encouraged to
   use a 64-bit kernel.
   .
   If you decide to continue using ZFS on a 32-bit kernel then keep in
   mind that it is at your own risk.

> Template: zfs-dkms/stop-build-for-unknown-kernel
> Type: boolean
> Default: true
> Description:  Stop the build since your running kernel is unknown?

  Description: Abort building ZFS on an unknown kernel?

>  Couldn't determine if your running kernel is 64-bit or 32-bit.

This should be a full sentence, though I'm not sure of the best way to
phrase it.  Maybe:

   You are attempting to build ZFS against a running kernel that could not
   be identified as 32-bit or 64-bit.

>  .
>  At the moment ZFS will build in a 32-bit environment but it is
>  UNSUPPORTED and will likely cause instability and may lead to data
>  corruption. You are strongly encouraged to use ZFS on a 64-bit kernel.

(As above)

>  .
>  Please, only continue with the build if you are completely sure
>  that your running kernel is a 64-bit one. If is not the case, or
>  you are unsure please stop the current build.

That needs some tweaks:

   You should only continue with the build if you are completely sure that
   your running kernel is a 64-bit one. If this is not the case, or you
   are unsure, please stop the current build.

>  .
>  Keep in mind that if you decide to continue using ZFS on a 32-bit kernel
>  is at your own risk.

(As above)

But this is getting a bit long.  One way of reducing the paragraph
count would be to merge the variable lines, which would also make it
possible to merge the other two:

  Description: Abort building ZFS on a 32-bit kernel?
   You are attempting to build ZFS against a 32-bit running kernel.
   .
   Although possible, building in a 32-bit environment is unsupported and
   likely to cause instability leading to possible data corruption. You
   are strongly advised to use a 64-bit kernel; if you do decide to
   proceed with using ZFS on this kernel then keep in mind that it is at
   your own risk.

  Description: Abort building ZFS on an unknown kernel?
   You are attempting to build ZFS against a running kernel that could not
   be identified as 32-bit or 64-bit. If you are not completely sure that
   the running kernel is a 64-bit one, you should probably stop the build.
   .
   Although possible, building in a 32-bit environment is unsupported and
   likely to cause instability leading to possible data corruption. You
   are strongly advised to use a 64-bit kernel; if you do decide to
   proceed with using ZFS on this kernel then keep in mind that it is at
   your own risk.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru old/zfs-dkms.templates new/zfs-dkms.templates
--- old/zfs-dkms.templates	2013-06-28 19:53:55.856881189 +0100
+++ new/zfs-dkms.templates	2013-06-28 21:17:12.214619354 +0100
@@ -1,30 +1,25 @@
 Template: zfs-dkms/stop-build-for-32bit-kernel
 Type: boolean
 Default: true
-Description:  Stop the build since your running kernel is 32-bit?
- You are attempting to build ZFS on a 32-bit kernel.
+Description: Abort building ZFS on a 32-bit kernel?
+ You are attempting to build ZFS against a 32-bit running kernel.
  .
- At the moment ZFS will build in a 32-bit environment but it is
- UNSUPPORTED and will likely cause instability and may lead to data
- corruption. You are strongly encouraged to use ZFS on a 64-bit kernel.
- .
- Keep in mind that if you decide to continue using ZFS on a 32-bit
- kernel then it is at your own risk.
-
+ Although possible, building in a 32-bit environment is unsupported and
+ likely to cause instability leading to possible data corruption. You
+ are strongly advised to use a 64-bit kernel; if you do decide to
+ proceed with using ZFS on this kernel then keep in mind that it is at
+ your own risk.
 
 Template: zfs-dkms/stop-build-for-unknown-kernel
 Type: boolean
 Default: true
-Description:  Stop the build since your running kernel is unknown?
- Couldn't determine if your running kernel is 64-bit or 32-bit.
- .
- At the moment ZFS will build in a 32-bit environment but it is
- UNSUPPORTED and will likely cause instability and may lead to data
- corruption. You are strongly encouraged to use ZFS on a 64-bit kernel.
- .
- Please, only continue with the build if you are completely sure
- that your running kernel is a 64-bit one. If is not the case, or
- you are unsure please stop the current build.
+Description: Abort building ZFS on an unknown kernel?
+ You are attempting to build ZFS against a running kernel that could not
+ be identified as 32-bit or 64-bit. If you are not completely sure that
+ the running kernel is a 64-bit one, you should probably stop the build.
  .
- Keep in mind that if you decide to continue using ZFS on a 32-bit kernel
- is at your own risk.
+ Although possible, building in a 32-bit environment is unsupported and
+ likely to cause instability leading to possible data corruption. You
+ are strongly advised to use a 64-bit kernel; if you do decide to
+ proceed with using ZFS on this kernel then keep in mind that it is at
+ your own risk.
-------------- next part --------------
Template: zfs-dkms/stop-build-for-32bit-kernel
Type: boolean
Default: true
Description: Abort building ZFS on a 32-bit kernel?
 You are attempting to build ZFS against a 32-bit running kernel.
 .
 Although possible, building in a 32-bit environment is unsupported and
 likely to cause instability leading to possible data corruption. You
 are strongly advised to use a 64-bit kernel; if you do decide to
 proceed with using ZFS on this kernel then keep in mind that it is at
 your own risk.

Template: zfs-dkms/stop-build-for-unknown-kernel
Type: boolean
Default: true
Description: Abort building ZFS on an unknown kernel?
 You are attempting to build ZFS against a running kernel that could not
 be identified as 32-bit or 64-bit. If you are not completely sure that
 the running kernel is a 64-bit one, you should probably stop the build.
 .
 Although possible, building in a 32-bit environment is unsupported and
 likely to cause instability leading to possible data corruption. You
 are strongly advised to use a 64-bit kernel; if you do decide to
 proceed with using ZFS on this kernel then keep in mind that it is at
 your own risk.