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.
Details
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.) |
share/man/man9/compressor.9 | ||
---|---|---|
87 | I have no idea what happened there. |