Skip to content

Commit

Permalink
Add doc note about viewing feature-gated docs
Browse files Browse the repository at this point in the history
Signed-off-by: alindima <[email protected]>
  • Loading branch information
alindima committed Sep 30, 2021
1 parent af54559 commit 31ba0af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,15 @@ It’s interesting to note that installing the filter does not take ownership or
invalidate the BPF program, thanks to the kernel which performs a
`copy_from_user` on the program before installing it.

### Feature documentation

The documentation on [docs.rs](https://docs.rs/seccompiler/)
does not include the feature-gated json functionality.

In order to view the documentation including the optional json feature, you may
run:
`cargo doc --open --all-features`

## Seccomp best practices

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

0 comments on commit 31ba0af

Please sign in to comment.