Page MenuHomeFreeBSD

geli(8): Add an example on how to use geli(8) with a file as encrypted storage
ClosedPublic

Authored by gbe on Jul 20 2020, 9:55 AM.

Details

Summary

geli(8): Add an example on how to use geli(8) with a file as encrypted storage

Test Plan

mandoc output review and 'mandoc -Tlint' checks

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

gbe requested review of this revision.Jul 20 2020, 9:55 AM
gbe created this revision.

The use of "you" is discouraged, see https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html.
I think it shortens the sentences a bit. I've marked some other minor mistakes. In general, I like the example and it's a great addition to the man page.

lib/geom/eli/geli.8
1115 ↗(On Diff #74683)

maybe add an "automatically" to this sentence?

1128 ↗(On Diff #74683)

s/asking/asked/ (or requested)

1149 ↗(On Diff #74683)

/asks/ask/

1151 ↗(On Diff #74683)

maybe shorten this sentence a bit: "... the boot process is stopped asking for the passphrase" or "...waiting for the passphrase input".

  • Avoid using 'you' in the example sentences
gbe marked 4 inline comments as done.Jul 20 2020, 11:14 AM
In D25741#569676, @bcr wrote:

The use of "you" is discouraged, see https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style.html.
I think it shortens the sentences a bit. I've marked some other minor mistakes. In general, I like the example and it's a great addition to the man page.

Thanks for feedback, I integrated it and removed the 'you's.

lib/geom/eli/geli.8
1127 ↗(On Diff #74685)

a "you" sneaked in here... ;-)

"... when geli init is called."

  • Remove a missed 'you' in a sentence
gbe marked an inline comment as done.Jul 20 2020, 11:31 AM
gbe added inline comments.
lib/geom/eli/geli.8
1127 ↗(On Diff #74685)

Damn. :)

I know have it removed.

No worries, good things take time. Speaking of time: the time ha come to commit it. ;-)
Thank you!

This revision is now accepted and ready to land.Jul 20 2020, 11:42 AM
This revision was automatically updated to reflect the committed changes.
gbe marked an inline comment as done.