Skip to content

Commit

Permalink
README: improve build tags docs
Browse files Browse the repository at this point in the history
1. Provide a more realistic example of using make BUILDTAGS=

2. Fix nokmem dependencies cell (<none> was not rendered).

3. Add information about auto-setting nokmem tag for EL7 kernel.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
  • Loading branch information
kolyshkin committed Mar 4, 2021
1 parent fda5e37 commit 446cbcd
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,19 @@ sudo make install
with some of them enabled by default (see `BUILDTAGS` in top-level `Makefile`).

To change build tags from the default, set the `BUILDTAGS` variable for make,
e.g.
e.g. to disable `seccomp` and enable `nokmem`, run:

```bash
make BUILDTAGS='seccomp'
make BUILDTAGS="nokmem"
```

| Build Tag | Feature | Enabled by default | Dependency |
|-----------|------------------------------------|--------------------|------------|
| seccomp | Syscall filtering | yes | libseccomp |
| nokmem | disable kernel memory accounting | no | <none> |
| nokmem | disable kernel memory accounting | usually not | _none_ |

**Note** `nokmem` build tag is now auto-set by the Makefile in case
the running kernel version looks like one from RHEL7 (3.10.0-\*.el7.)

The following build tags were used earlier, but are now obsoleted:
- **apparmor** (since runc v1.0.0-rc93 the feature is always enabled)
Expand Down

0 comments on commit 446cbcd

Please sign in to comment.