Extending the bsdinstall(8) documentation to include ZFS scripted installation

[0mp]

Summary

Extension of the bsdinstall(8) man page with ZFS scripted installation

Extension of the bsdinstall(8) man page with description of all the ZFS variables involved in a ZFS based scripted installation.

Extension of the SCRIPTING section of the man page to include an example for a ZFS scripted installation, explaining how to write the variables described before.

Creation of a new section to explain how the ZFS datasets must be written into a variable to get them set on the final system.

[dteske]

I ran mandoc -mdoc -Tlint against your patched bsdinstall.8. Lines 373, 507, and 509 need attention.

NB: bsdinstall.8 passes mandoc -mdoc -Tlint cleanly before patch.

I ran igor -Dgpxy and (aside from mandoc issues above) line 527 needs attention.

NB: igor has complaints before your patch is applied, but I have discounted them and only listed the issues pertaining to your patch.

Also from igor is the style check against your patch:

["your" used 3 times]
  "You" and "your" are informal and subjective.
  Attempt to be formal and objective: "the file" rather than "your file".
["should" used 2 times]
  Use "should" sparingly, it is feeble and suggests unsureness.
  Attempt to be imperative: "do this" rather than "you should do this".
["the following" used 1 time]
  If something is following, the reader can see it without being told.

usr.sbin/bsdinstall/bsdinstall.8

373 ↗

(On Diff #38778)

From mandoc -mdoc -Tlint

mandoc: bsdinstall.8:373:66: WARNING: whitespace at end of input line

507 ↗

(On Diff #38778)

From mandoc -mdoc -Tlint

mandoc: bsdinstall.8:507:1: WARNING: blank line in fill mode, using .sp

509 ↗

(On Diff #38778)

From mandoc -mdoc -Tlint

mandoc: bsdinstall.8:509:4: WARNING: whitespace at end of input line

527 ↗

(On Diff #38778)

From igor -Dgpxy

bsdinstall.8:527:contraction:# [Don't] mount /usr so that 'base' files go to the BEROOT

Use "Do not" instead of contraction

560 ↗

(On Diff #38778)

Section is for authors of tool, not manual

[larafercue_gmail.com]

Modifying the patch with changes suggested by dteske@

• Applying the style needed using mandoc(1) and igor(1).
• Removing my name from the AUTHORS section.

[bcr]

@dteske: Can you take a final look on the updated patch? Would be good to have this in the man page. Thank you!

[dteske]

Looks good. Thanks!

[0mp]

I've talked with @roberfern_gmail.com about this patch.

I'll take care of it.

[0mp]

• Add Roberto to the copyrights for recognition as changes to the manual page are huge.
• Bump date (I'll have to do it again when committing).
• Use "Dq" for default values.
• Use sysrc instead of echo in examples.