Page MenuHomeFreeBSD

Document geli(8) loader variables conventions
ClosedPublic

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

Details

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
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

0mp created this revision.Wed, Mar 18, 2:53 PM
0mp added a subscriber: woodsb02.Wed, Mar 18, 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”.
bcr added a comment.Wed, Mar 18, 3:43 PM

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.

0mp updated this revision to Diff 69643.Wed, Mar 18, 3:51 PM
  • Fix style issues (thanks @bcr).
bcr accepted this revision.Wed, Mar 18, 3:56 PM

Good to go! Thank you.

This revision is now accepted and ready to land.Wed, Mar 18, 3:56 PM
This revision was automatically updated to reflect the committed changes.