docs: fix --containerd-socket -> --containerd-address in README#271
Closed
SAY-5 wants to merge 1 commit into
Closed
docs: fix --containerd-socket -> --containerd-address in README#271SAY-5 wants to merge 1 commit into
SAY-5 wants to merge 1 commit into
Conversation
The containerd backend registers --containerd-address (see cmd/diffoci/backend/containerdbackend/containerdbackend.go:26), but the README documents a --containerd-socket flag that does not exist. Running the documented command fails with 'unknown flag: --containerd-socket'. Fixes #265 Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
SAY-5
force-pushed
the
fix-readme-containerd-flag
branch
from
3a92c3e to
1ebabd6
Compare
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #265.
Problem
README.md:100 documents the containerd backend as:
But
--containerd-socketis not a real flag. The containerd backend registers--containerd-addressatcmd/diffoci/backend/containerdbackend/containerdbackend.go:26:Running the documented command produces:
Fix
Update the README example to use the real flag name (
--containerd-address) and a value placeholder (ADDRESS) that matches theCONTAINERD_ADDRESSenv var the code reads.