Page MenuHomeFreeBSD

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

Authored by 0mp on Feb 2 2018, 3:36 PM.
Referenced Files
Unknown Object (File)
Sep 8 2023, 1:48 PM
Unknown Object (File)
Sep 5 2023, 2:45 AM
Unknown Object (File)
Aug 15 2023, 9:53 AM
Unknown Object (File)
Aug 15 2023, 9:53 AM
Unknown Object (File)
Jun 24 2023, 3:29 AM
Unknown Object (File)
Jun 8 2023, 3:58 AM
Unknown Object (File)
May 28 2023, 1:41 AM
Unknown Object (File)
May 27 2023, 12:58 AM



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.

Diff Detail

rS FreeBSD src repository - subversion
Lint Not Applicable
Tests Not Applicable

Event Timeline

dteske requested changes to this revision.Feb 4 2018, 12:57 PM

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.
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

This revision now requires changes to proceed.Feb 4 2018, 12:57 PM

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.

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

This revision is now accepted and ready to land.Mar 14 2018, 6:10 PM
0mp added a reviewer:
0mp added a subscriber: 0mp.

I've talked with about this patch.

I'll take care of it.

0mp planned changes to this revision.Sep 26 2018, 4:16 PM
  • 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.
This revision was not accepted when it landed; it landed in state Needs Review.Oct 4 2018, 9:28 AM
This revision was automatically updated to reflect the committed changes.