Restructure the crypto(7) manpage and add authentication algorithms.
ClosedPublic
Actions

Authored by jhb on Dec 30 2020, 12:49 AM.

Details

Reviewers

cem
jmg

Group Reviewers

manpages

Commits

rG4a6cd37b755c: Restructure the crypto(7) manpage and add authentication algorithms.

Summary

Add separate sections for authentication algorithms, block ciphers,
stream ciphers, and AEAD algorithms. Describe properties commmon to
algorithms in each section to avoid duplication.

Use flat tables to list algorithm properties rather than nested
tables.

List implemented authentication algorithms.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

jhb created this revision.Dec 30 2020, 12:49 AM

Herald added a reviewer: manpages. · View Herald TranscriptDec 30 2020, 12:49 AM

Herald added a subscriber: imp. · View Herald Transcript

jhb requested review of this revision.Dec 30 2020, 12:49 AM

Harbormaster completed remote builds in B35775: Diff 81349.Dec 30 2020, 12:49 AM

jhb added a child revision: D27834: Reject AES-GCM and AES-CCM sessions with per-op keys..Dec 30 2020, 12:49 AM

jhb added a reviewer: cem.Dec 30 2020, 12:54 AM

jhb added a subscriber: gallatin.

jhb added a reviewer: jmg.Dec 30 2020, 12:57 AM

debdrup added subscribers: bcr, debdrup.Jan 6 2021, 1:00 PM

debdrup added inline comments.

share/man/man7/crypto.7
30	Since @bcr hasn't been here yet, I get to remind someone else to remember to bump .Dd ;)
171	s/manpage/man-page/, according to igor

0mp added a subscriber: 0mp.Jan 6 2021, 4:44 PM

0mp added inline comments.

share/man/man7/crypto.7
167	Missing comma.
171	Shouldn't it be just /manual page/?

debdrup added inline comments.Jan 6 2021, 8:09 PM

share/man/man7/crypto.7
171	I just checked intro(4), devfs(5), and a couple other manual pages, and that is indeed the phrasing, so yes. :)

Add comma, correct pre-existing "manpage".

Harbormaster completed remote builds in B36045: Diff 81918.Jan 8 2021, 8:57 PM

jhb added inline comments.Jan 8 2021, 8:57 PM

share/man/man7/crypto.7
30	Since @bcr hasn't been here yet, I get to remind someone else to remember to bump .Dd ;) I don't bother bumping until the commit date since it is always stale during review otherwise.
167	Missing comma. Is it also better to spell out "for example" explicitly?