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

Authored by 0mp on Feb 2 2018, 3:36 PM.

Details

Reviewers

allanjude
dteske
larafercue_gmail.com
mat
krion

Group Reviewers

Doc Committers
manpages

Commits

rS339179: bsdinstall(8): Document ZFS installation scripting.

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.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 14788
Build 14907: arc lint + arc unit

Event Timeline

larafercue_gmail.com created this revision.Feb 2 2018, 3:36 PM

Herald added a reviewer: manpages. · View Herald TranscriptFeb 2 2018, 3:36 PM

Herald added a subscriber: imp. · View Herald Transcript

dteske added a reviewer: dteske.Feb 3 2018, 7:35 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.

usr.sbin/bsdinstall/bsdinstall.8
373	From `mandoc -mdoc -Tlint` mandoc: bsdinstall.8:373:66: WARNING: whitespace at end of input line
507	From `mandoc -mdoc -Tlint` mandoc: bsdinstall.8:507:1: WARNING: blank line in fill mode, using .sp
509	From `mandoc -mdoc -Tlint` mandoc: bsdinstall.8:509:4: WARNING: whitespace at end of input line
527	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	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.

larafercue_gmail.com marked 5 inline comments as done.Feb 5 2018, 12:09 PM

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

Looks good. Thanks!

This revision is now accepted and ready to land.Mar 14 2018, 6:10 PM

I've talked with @roberfern_gmail.com 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.

Harbormaster completed remote builds in B19835: Diff 48499.Sep 27 2018, 10:09 AM

0mp added reviewers: mat, krion.Sep 27 2018, 10:12 AM

This revision was not accepted when it landed; it landed in state Needs Review.Oct 4 2018, 9:28 AM

Closed by commit rS339179: bsdinstall(8): Document ZFS installation scripting. (authored by 0mp). · Explain Why

This revision was automatically updated to reflect the committed changes.