My try to document capsicum helpers.
Details
Details
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
| lib/libcapsicum/capsicum_helpers.3 | ||
|---|---|---|
| 64 ↗ | (On Diff #21065) | no need for "the" |
| 66 ↗ | (On Diff #21065) | linking -> link But I might remove the clause about linking entirely. |
| 70 ↗ | (On Diff #21065) | .Fn caph_limit_stream restricts capabilities on .Fa fd to only those needed by POSIX stream objects (that is, FILEs). |
| 71–72 ↗ | (On Diff #21065) | Implementation details. I think this should be omitted from the page. If users rely upon these specific rights, their applications may break if we ever change those rights. |
| 73–76 ↗ | (On Diff #21065) | Same. (Implementation detail subject to change.) I think this should be removed. |
| 82 ↗ | (On Diff #21065) | error -> an error, descriptors -> descriptor |
| 93 ↗ | (On Diff #21065) | functions limit standard descriptors using .Fn caph_limit_stream . |
| 98 ↗ | (On Diff #21065) | s/ using standard method// The preceding sentence, the names, and the remainder of this sentence makes this clear. |
| 100–102 ↗ | (On Diff #21065) | .Fn caph_cache_tzdata precaches all timezone data needed to use .Li libc local time functions. |
| 106–108 ↗ | (On Diff #21065) | The .Nm foo function -> .Fn foo here, too. .Fn caph_cache_catpages caches Native Language Support (NLS) data. |
| 109 ↗ | (On Diff #21065) | NLS data is used for localized error printing by .Xr strerror 3 and .Xr err 3 , among others. |
| 114–115 ↗ | (On Diff #21065) | These two (fcntl, ioctl) can be removed. |
| lib/libcapsicum/capsicum_helpers.3 | ||
|---|---|---|
| 66 ↗ | (On Diff #21077) | I would just remove the clause. We intend to make this into a library that requires linking, so the current header-only status is a temporary implementation detail. |
| 99 ↗ | (On Diff #21077) | precaches :-) |
| 103–105 ↗ | (On Diff #21077) | The .Fn caph_cache_catpages function can just be .Fn caph_cache_catpages |
| lib/libcapsicum/capsicum_helpers.3 | ||
|---|---|---|
| 66 ↗ | (On Diff #21077) | What about a overall comment about this being in flux and that implementation details may change? I think we want to suggest that these are somewhat experimental at the moment. Obviously "we" will take care of all in-tree consumers, but external consumers should know they may have to do some rework. |
Comment Actions
I'm still not sure how libcapsicum will look like but I would love to see that capsicum helpers don't need additional library.
| lib/libcapsicum/capsicum_helpers.3 | ||
|---|---|---|
| 103 ↗ | (On Diff #21082) | No "The" needed either. :) |
Comment Actions
@cem what about caph_cache_tzdata, caph_limit_{stdin,stderr,stdout} and caph_limit_stream, should I remove all "function(s)" and "the"?
| head/lib/libcapsicum/capsicum_helpers.3 | ||
|---|---|---|
| 60 | Probably not necessary to capitalize "Capsicumizing". There is a little ambiguity in whether these functions simplify capsicumizing (modifying) some programs, or whether they simplify "capsicumizing programs" (programs which are used to capsicumize other programs). The first meaning is certainly intended, so maybe just switch it to say "...simplify modifying programs to use Capsicum." | |
| 73 | s/The following/These/ | |