beinstall.sh: Use bectl instead of beadm by default
ClosedPublic
Actions

Authored by 0mp on Jul 30 2019, 10:03 AM.

Details

Reviewers

will
brd
kevans

Group Reviewers

manpages

Commits

rS367159: beinstall.sh: Use bectl instead of beadm by default

Summary

beinstall.sh: Use bectl instead of beadm by default

This patch also introduces an environment variable BE_UTILITY, which can be
used to specify the utility to use for managing ZFS boot environments (which
can be either bectl or beadm).

While here, fix some typos in the manual page and remove beadm from section
"SEE ALSO".

Test Plan

Apply the patch
Upgrade a system with beinstall

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

0mp created this revision.Jul 30 2019, 10:03 AM

Herald added a reviewer: manpages. · View Herald TranscriptJul 30 2019, 10:03 AM

Herald added a subscriber: imp. · View Herald Transcript

Harbormaster completed remote builds in B25584: Diff 60268.Jul 30 2019, 10:03 AM

A few suggestions, nothing major.

share/man/man8/beinstall.8
66 ↗	(On Diff #60268)	I would leave the "a" here from the original.
89 ↗	(On Diff #60268)	I'd use either "from the Ports Collection" or simply "from ports".

Throwing myself on as a reviewer so I remember to circle back to this... I seem to recall that bectl might have some issue with mount (not mounting everything that might be needed for some setups, maybe?) -- I'll search through my e-mail and get back to this, though.

I second @bcr's manpages comments. Otherwise LGTM.

kevans added inline comments.Jul 30 2019, 9:37 PM

share/man/man8/beinstall.8
83 ↗	(On Diff #60268)	It seemed like we generally used "FOO_CMD" for this kind of thing, but I might be mixing up conventions between FreeBSD and $work.

Improve wording (as suggested by @bcr)

Harbormaster completed remote builds in B25720: Diff 60534.Aug 7 2019, 8:29 AM

0mp marked 3 inline comments as done.Aug 7 2019, 8:30 AM

0mp added inline comments.

share/man/man8/beinstall.8
66 ↗	(On Diff #60268)	Done
83 ↗	(On Diff #60268)	We use `CONFIG_UPDATER` in this script, so that's why I decided not to follow the `_CMD` convention from ports.
89 ↗	(On Diff #60268)	Done

0mp added 1 blocking reviewer(s): kevans.Aug 7 2019, 8:31 AM

@kevans There is a bug report that bectl might have some problems with the activate command: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=239702

FWIW, in consultation w/ @kevans, I did s/beadm/bectl/g on beinstall,sh to get myself out of a problem, and it worked without issue.

Manpage is good now. Thanks.

kevans added inline comments.Oct 25 2020, 3:09 PM

tools/build/beinstall.sh
163 ↗	(On Diff #60534)	I would consider adding an additional seatbelt here, though this I suppose this is more of an advanced tool: if [ "$(basename ${BE_UTILITY})" = "bectl" ]; then ${BE_UTILITY} check \|\| errx "bectl sanity check failed" fi bectl check was added so that freebsd-update can cleanly not try boot environment stuff if the system doesn't appear to be setup for boot environments.