bsdinstall: Provide help text for partitioning options

[woodsb02]

Summary

bsdinstall: Provide help text for partitioning options

Includes commentary of when ZFS or UFS are recommended.

Also hoist the options text to the top of script as variables
(will help with future international translations).

Test Plan

Test run bsdinstall - works ok

[woodsb02]

Use dialog menu tag variables in subsequent case statement
(rather than re-typing the variable contents)

[philip]

Looks good to me!

[woodsb02]

Modify help text inline with discussion on freebsd-arch@ mailing list.

[philip]

Looks good. I like the pointer to the tuning guide.

[woodsb02]

msg_partitioning_ufs_help: Update text to avoid implying multiple disks can be selected

[rgrimes]

Other than perhaps a uniformity issue, that you can ignore if you wish, this looks fine to me.

usr.sbin/bsdinstall/scripts/auto

56

To be more uniform could this be "Guided UFS Disk Setup" as the zfs desc above explicity mentions ZFS too.

[dteske]

usr.sbin/bsdinstall/scripts/auto

52–63

The variable names here need to be adjusted.

msg_partititoning_zfs="Auto (ZFS)"

For example should be:

msg_auto_zfs="Auto (ZFS)"

So that when used in code, the code reads like the text. Also, when searching the code, one can prepend "msg_", change to lower-case, and replace non-printable characters and spaces into underscore to find uses of the text.

Also, should the text be re-usable elsewhere, it is not tied to the partitioning menu. This is so that when someone performs international translation, fewer translations have to be made. For example, there is no reason to have:

msg_partitioning_shell="Shell"

When the following will do:

msg_shell="Shell"

Which makes any singular occurrence of the word "Shell" accessible under the "msg_shell" variable. Unnecessarily localizing individual words and phrases to a particular dialog, function, or module creates duplication and extra work for translators.

[woodsb02]

• Mention "UFS" in description of "Auto (UFS)" option (recommended by rgrimes)
• Adjust variable names to read like the text (recommended by dteske)
• Sort msg_ variable definitions in alphabetical order (as per scripts/zfsboot)

[woodsb02]

Thanks Rod and Devin for your comments - I have incorporated them