Skip to content

fix(checkpoint): remove unimplemented options from help output#3455

Merged
YJDoc2 merged 1 commit intoyouki-dev:mainfrom
nayuta723:fix-checkpoint-help
Mar 23, 2026
Merged

fix(checkpoint): remove unimplemented options from help output#3455
YJDoc2 merged 1 commit intoyouki-dev:mainfrom
nayuta723:fix-checkpoint-help

Conversation

@nayuta723
Copy link
Copy Markdown
Contributor

@nayuta723 nayuta723 commented Mar 15, 2026

Description

Convert doc comments (///) to regular comments (//) for TODO options
and reference links in the Checkpoint struct in crates/liboci-cli/src/checkpoint.rs.

Clap uses doc comments to generate --help output, so unimplemented options
were 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_id positional argument
so it appears correctly in help output.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test updates
  • CI/CD related changes
  • Other (please describe):

Testing

  • Added new unit tests
  • Added new integration tests
  • Ran existing test suite
  • Tested manually (please provide steps)
$ ./youki checkpoint --help
Checkpoint a running container

Usage: youki checkpoint [OPTIONS] <CONTAINER_ID>

Arguments:
  <CONTAINER_ID>  Identifier of the container

Options:
      --image-path <IMAGE_PATH>  Path for saving criu image files [default: checkpoint]
      --work-path <WORK_PATH>    Path for saving work files and logs
      --leave-running            Leave the process running after checkpointing
      --tcp-established          Allow open tcp connections
      --ext-unix-sk              Allow external unix sockets
      --shell-job                Allow shell jobs
      --file-locks               Allow file locks
  -h, --help                     Print help

Related Issues

Fixes #3453

Additional Context

Copy link
Copy Markdown
Collaborator

@YJDoc2 YJDoc2 left a comment

Choose a reason for hiding this comment

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

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.

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>
@nayuta723 nayuta723 force-pushed the fix-checkpoint-help branch from 343cf62 to bee4604 Compare March 17, 2026 15:20
@nayuta723 nayuta723 requested a review from YJDoc2 March 18, 2026 15:58
@YJDoc2 YJDoc2 merged commit 60dd1df into youki-dev:main Mar 23, 2026
28 checks passed
@github-actions github-actions bot mentioned this pull request Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove TODO comments from checkpoint --help output

2 participants