Some fixes to bsdinstall(8) documentation
ClosedPublic
Actions

Authored by arrowd on Dec 26 2019, 9:57 AM.

Details

Reviewers

0mp
bcr

Group Reviewers

Doc Committers
docs
manpages

Commits

rS357638: Improve documentation of bootconfig and PARTITIONS

Summary

Mention bootconfig target in TARGETS section.
Fix example for DISTRIBUTIONS variable. The .tgz suffixes are required.
Document PARTITIONS variable, which is only mentioned in the examples, but doesn't have its own point.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

arrowd created this revision.Dec 26 2019, 9:57 AM

Herald added a reviewer: manpages. · View Herald TranscriptDec 26 2019, 9:57 AM

Herald added a subscriber: imp. · View Herald Transcript

Harbormaster completed remote builds in B28325: Diff 65996.Dec 26 2019, 9:57 AM

Found two issues. Maybe textproc/igor and "mandoc -Tlint" will find some more.

usr.sbin/bsdinstall/bsdinstall.8
122 ↗	(On Diff #65996)	s/approprate/appropriate/
268 ↗	(On Diff #65996)	You need to have a line break after a sentence stop.

Address comments.
Add gpart bootcode command invocation into UFS example.

Harbormaster completed remote builds in B28332: Diff 66017.Dec 27 2019, 5:19 AM

mandoc -Tlint clean.
igor complains about date being not today (line 28) . Should I change it?

0mp added a subscriber: 0mp.Dec 27 2019, 7:23 AM

0mp added inline comments.

usr.sbin/bsdinstall/bsdinstall.8
265 ↗	(On Diff #66017)	This has been committed in rS354967
268 ↗	(On Diff #65996)	How about "The partitioning of the disk onto which...". This way it would match descriptions of other environment variables in this section.

In D22927#502434, @arrowd wrote:

mandoc -Tlint clean.

igor complains about date being not today (line 28) . Should I change it?

Yes, but we usually change it once all issues are cleared up and then it becomes the date of the commit. For people who don't have a commit bit, it will be done by the person doing the commit.