Differential D24114

Document geli(8) loader variables conventions
ClosedPublic
Actions

Authored by 0mp on Mar 18 2020, 2:53 PM.

Details

Reviewers

bcr

Group Reviewers

manpages

Commits

rS359960: MFC 359125:
rS359125: Document geli(8) loader variables conventions

Summary

Document geli(8) loader variables conventions

The geli(8) manual page has an example for preloading keyfiles during boot.
There is no detail though on how the lookup of these variables actually works.

Let's document that the name of the device does not have to be a part of the
variable.

PR:	243261
Submitted by:	johannes@jo-t.de
MFC after:	3 weeks

Bugzilla: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=243261

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

0mp created this revision.Mar 18 2020, 2:53 PM

Herald added a reviewer: manpages. · View Herald TranscriptMar 18 2020, 2:53 PM

Herald added a subscriber: imp. · View Herald Transcript

Harbormaster completed remote builds in B29996: Diff 69639.Mar 18 2020, 2:53 PM

BTW, the modified section renders like this:

By convention, these loader variables are called geli_<device>_load.
However, the actual name prefix before _load, _type, or _name does not
matter. At boot time, the geli module searches through all
<prefix>_type-like variables that have a value of
“<device>:geli_keyfile”.  The paths to keyfiles are then extracted from
<prefix>_name variables.  In the example above, prefix is
“geli_da1s3a_keyfile”.

Two comments.

lib/geom/eli/geli.8
1020 ↗	(On Diff #69639)	Can you fill this line a bit more by pulling up text from the following line?
1025 ↗	(On Diff #69639)	Line break after a sentence stop.