Skip to content

Commit 31ba0af

Browse files
committed
Add doc note about viewing feature-gated docs
Signed-off-by: alindima <[email protected]>
1 parent af54559 commit 31ba0af

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,15 @@ It’s interesting to note that installing the filter does not take ownership or
288288
invalidate the BPF program, thanks to the kernel which performs a
289289
`copy_from_user` on the program before installing it.
290290

291+
### Feature documentation
292+
293+
The documentation on [docs.rs](https://docs.rs/seccompiler/)
294+
does not include the feature-gated json functionality.
295+
296+
In order to view the documentation including the optional json feature, you may
297+
run:
298+
`cargo doc --open --all-features`
299+
291300
## Seccomp best practices
292301

293302
- Before installing a filter, make sure that the current kernel version

0 commit comments

Comments
 (0)