Page MenuHomeFreeBSD

bectl: add some discussion about boot environment layouts
ClosedPublic

Authored by kevans on Mar 12 2022, 4:09 AM.

Details

Summary

Discuss the standard type of layout, as well as the "deep" BE layout,
and some of the properties of both. Point the various -r flags at this
new section, to help users understand which they're working with and
what the -r flag is actually doing. Note that we may just deprecate the
-r flag in future versions, but the flag will be recognized as a NOP at
that point.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Looks good overall other than these two points.

sbin/bectl/bectl.8
354

Maybe expand on "traditional", eg that it's what autoZFS install gives you? (If my guess it does is correct.)

366

Maybe mention this is the output of zfs list -o name,canmount,mountpoint? (If it is - It looks that way on 12.2, but maybe OpenZFS does things differently.)

393

Is "The other style of boot environments" singular or plural in US English? That is, should the verb it's the subject of be "organizes" or "organize"? My instinct tells me "organize" is "collective is plural" so British/Commonwealth English.

(I can count to 3. Honest.)

sbin/bectl/bectl.8
393

Someone confirmed my instinct in IRC.

This revision now requires changes to proceed.Mar 12 2022, 11:18 PM
grahamperrin added inline comments.
sbin/bectl/bectl.8
183

This comment is based on my limited experience, the one line:

bectl destroy: leaving origin 'copperbowl/ROOT/n257337-5fe0cd6503d-e@2021-03-22-02:06:44' intact

– observed whilst performing multiple destructions without -o at shown at https://bz-attachments.freebsd.org/attachment.cgi?id=223539


It's not quite under the umbrella of D34538, but it might help readers to get the 'big picture'.

sbin/bectl/bectl.8
183

if in lieu of that – a significant difference – do I understand correctly?

Paraphrasing (please correct me if I'm wrong):


Without -o: if the origin of beName will be left intact, bectl will report the remnant whilst destroying the boot environment.

With -o: bectl will unconditionally destroy the origin.

kevans marked 4 inline comments as done.

Address feedback from Pau

sbin/bectl/bectl.8
366

I struggled to figure out how to work that into the surrounding text, but it occurred to me I could probably just include that in the literal block with with a $ to indicate the prompt.

This revision is now accepted and ready to land.Mar 19 2022, 1:28 AM