Skip to content

Commit

Permalink
contrib/cmd: add README.md to clarify the intent
Browse files Browse the repository at this point in the history
So as to clarify that distro maintainers should not include these
contrib command binaries (`recvtty`, `sd-helper`, `seccompagent`, etc.)
in their packages.

ref: https://bugs.launchpad.net/ubuntu/+source/runc/+bug/2076981

Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
  • Loading branch information
AkihiroSuda committed Aug 14, 2024
1 parent 2ee5564 commit d86d8e9
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ runc-bin: runc-dmz

.PHONY: all
all: runc recvtty sd-helper seccompagent fs-idmap memfd-bind pidfd-kill remap-rootfs
@echo "*Note*: Only the runc binary should be installed to user environments."
@echo "Other binaries are provided as examples or test utilities. Users do not need them."

.PHONY: recvtty sd-helper seccompagent fs-idmap memfd-bind pidfd-kill remap-rootfs
recvtty sd-helper seccompagent fs-idmap memfd-bind pidfd-kill remap-rootfs:
Expand Down
3 changes: 3 additions & 0 deletions contrib/cmd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The command packages here are provided as either examples or test utilities.

These packages are not expected to be installed to user environments.

0 comments on commit d86d8e9

Please # to comment.