Skip to content

docs(readme): correct containerd backend flag to --containerd-address#272

Merged
AkihiroSuda merged 1 commit into
reproducible-containers:masterfrom
mvanhorn:osc/265-fix-containerd-address-flag
May 11, 2026
Merged

docs(readme): correct containerd backend flag to --containerd-address#272
AkihiroSuda merged 1 commit into
reproducible-containers:masterfrom
mvanhorn:osc/265-fix-containerd-address-flag

Conversation

@mvanhorn
Copy link
Copy Markdown
Contributor

Fixes #265

Summary

The "explicit enable containerd" example in README.md referenced --containerd-socket, which the binary rejects:

time="..." level=fatal msg="unknown flag: --containerd-socket"

Looking at cmd/diffoci/backend/containerdbackend/containerdbackend.go, the flag registered on the containerd backend is --containerd-address (bound to CONTAINERD_ADDRESS). --containerd-socket does not exist.

Change

README.md: update the example to use --containerd-address=ADDRESS, matching the actual flag name. --containerd-namespace was already correct.

Testing

Grepped the full tree (grep -rn "containerd-socket\|containerd-address") - the only remaining containerd-socket reference was in this README line; the flag registration, getter, and every other mention uses containerd-address.

DCO signoff included.

The explicit-enable example referenced --containerd-socket, which the
binary rejects (the flag does not exist). The actual flag registered
in cmd/diffoci/backend/containerdbackend/containerdbackend.go is
--containerd-address, bound to the CONTAINERD_ADDRESS env var.

Fixes reproducible-containers#265

Signed-off-by: Matt Van Horn <mvanhorn@gmail.com>
Copy link
Copy Markdown
Member

@AkihiroSuda AkihiroSuda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@AkihiroSuda AkihiroSuda merged commit 10845e1 into reproducible-containers:master May 11, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs are wrong for --containerd-socket

2 participants