Page MenuHomeFreeBSD

share: man: add some documentation for our kernel compressor API
AcceptedPublic

Authored by kevans on Sat, Jul 26, 3:55 PM.
Tags
None
Referenced Files
F125809334: D51562.diff
Tue, Aug 12, 6:09 AM
Unknown Object (File)
Mon, Aug 11, 10:50 AM
Unknown Object (File)
Tue, Jul 29, 2:03 AM
Unknown Object (File)
Mon, Jul 28, 12:46 AM
Unknown Object (File)
Mon, Jul 28, 12:16 AM
Unknown Object (File)
Sun, Jul 27, 7:56 PM
Unknown Object (File)
Sun, Jul 27, 6:21 PM
Unknown Object (File)
Sun, Jul 27, 5:51 PM

Details

Reviewers
markj
Group Reviewers
manpages
Summary

The API itself is pretty straightforward, but we could use a place to
document compressors that are available, how to enable them if they're
not already, and assumptions that can and cannot be made about their
availability.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 65765
Build 62648: arc lint + arc unit

Event Timeline

Adding manpages manually, didn't want to bother them with the first review in this stack.

share/man/man9/Makefile
887

_format.9 sorts before _init.9.

share/man/man9/compressor.9
47
49

feels a bit redundant with the previous sentence already qualifying "the kernel".

87

The buffer contains compressed data, len is the amount of compressed data available in the buffer, and offset is the current offset into the output stream. The offset parameter is a bit redundant, the consumer could keep track of it, but it's a bit simpler this way.

99

maxiosize is a bit of a misnomer, but in practice the callback is just writing the buffer to a file, so it effectively is a maximum I/O size.

147

This is stated twice, first starting on line 124.

160

It may be worth noting somewhere that the interface is suitable for use after a panic. (Except for compressor_init(), as it needs to allocate a buffer and set up state.)

kevans marked 7 inline comments as done.

Address review feedback, maybe

share/man/man9/compressor.9
87

I have no idea what happened there.

Just minor wording suggestions from me. Thanks for writing this.

share/man/man9/compressor.9
86
87
156
This revision is now accepted and ready to land.Sat, Jul 26, 9:54 PM

HISTORY and AUTHORS sections maybe? The rest LGTM.