Skip to content

Conversation

@jglogan
Copy link
Contributor

@jglogan jglogan commented Sep 21, 2025

  • Part of [Request]: Clean up help for complex commands. #515.
  • Order options alphabetically.
  • Use consistent descriptions for platform, os, arch.
  • Add os/arch options to push.
  • Rename ImageRemove to ImageDelete since delete is the primary command and rm is the alias.

Type of Change

  • Bug fix
  • New feature
  • Breaking change - rename ImageRemove type to ImageDelete
  • Documentation update

Motivation and Context

Clear, consistent presentation of command help.

Testing

  • Tested locally
  • Added/updated tests
  • Added/updated docs

- Part of apple#515.
- Order options alphabetically.
- Use consistent descriptions for platform, os, arch.
- Add os/arch options to push.
- Rename ImageRemove to ImageDelete since delete is
  the primary command and rm is the alias.
@jglogan jglogan requested a review from dkovba September 23, 2025 16:31
name: .shortAndLong,
help:
"Amount of builder container memory (1MiByte granularity), with optional K, M, G, T, or P suffix"
help: "Amount of builder container memory (1MiByte granularity), with optional K, M, G, T, or P suffix"
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we remove the P suffix for simplicity?

abstract: "Create a new reference for an existing image")

@Argument(help: "SOURCE_IMAGE[:TAG]")
@Argument(help: "the existing image reference (format: image-name[:tag])")
Copy link
Contributor

@dkovba dkovba Sep 23, 2025

Choose a reason for hiding this comment

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

Capitalize the help string.

var source: String

@Argument(help: "TARGET_IMAGE[:TAG]")
@Argument(help: "the new image reference")
Copy link
Contributor

@dkovba dkovba Sep 23, 2025

Choose a reason for hiding this comment

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

Capitalize the help string.

@jglogan jglogan merged commit e7018bc into apple:main Sep 23, 2025
2 checks passed
@jglogan jglogan deleted the image-options branch September 23, 2025 17:55
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.

2 participants