fix(checkpoint): remove unimplemented options from help output#3455
Merged
YJDoc2 merged 1 commit intoyouki-dev:mainfrom Mar 23, 2026
Merged
fix(checkpoint): remove unimplemented options from help output#3455YJDoc2 merged 1 commit intoyouki-dev:mainfrom
YJDoc2 merged 1 commit intoyouki-dev:mainfrom
Conversation
033edf5 to
ce7e736
Compare
YJDoc2
approved these changes
Mar 17, 2026
Collaborator
YJDoc2
left a comment
There was a problem hiding this comment.
lgtm
One minor note, I feel container identifier to be a better than identifier of the container . Personal opinion ; fine with keeping existing or discussing wording more.
13 tasks
ce7e736 to
343cf62
Compare
Convert doc comments (///) to regular comments (//) for TODO options and reference links in the Checkpoint struct. Doc comments are included in clap-generated --help output, so unimplemented options should not be advertised to users. Also adds a missing doc comment for the container_id argument. Signed-off-by: nayuta723 <nayuta723@gmail.com>
343cf62 to
bee4604
Compare
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
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.
Description
Convert doc comments (
///) to regular comments (//) for TODO optionsand reference links in the
Checkpointstruct incrates/liboci-cli/src/checkpoint.rs.Clap uses doc comments to generate
--helpoutput, so unimplemented optionswere incorrectly shown to users as if they were valid flags. This change hides
them while preserving the TODO notes for future implementation.
Also adds a missing doc comment for the
container_idpositional argumentso it appears correctly in help output.
Type of Change
Testing
Related Issues
Fixes #3453
Additional Context