Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct wording for buildpack new targets flag #2296

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

gogolok
Copy link
Contributor

@gogolok gogolok commented Dec 2, 2024

Summary

I'm not a native speaker, but the output from
pack buildpack new
regarding the flag --targets confuses me. I hope my change/suggestion makes it more understandable.

Output

Before

Error: accepts 1 arg(s), received 0
Usage:
  pack buildpack new <id> [flags]

Examples:
pack buildpack new sample/my-buildpack

Flags:
  -a, --api string        Buildpack API compatibility of the generated buildpack (default "0.8")
  -h, --help              Help for 'new'
  -p, --path string       Path to generate the buildpack
  -t, --targets strings   Targets are the list platforms that one targeting, these are generated as part of scaffolding inside buildpack.toml file. one can provide target platforms in format [os][/arch][/variant]:[distroname@osversion@anotherversion];[distroname@osversion]
                          	- Base case for two different architectures :  '--targets "linux/amd64" --targets "linux/arm64"'
                          	- case for distribution version: '--targets "windows/amd64:[email protected]"'
                          	- case for different architecture with distributed versions : '--targets "linux/arm/v6:[email protected]"  --targets "linux/arm/v6:[email protected]"'

  -V, --version string    Version of the generated buildpack (default "1.0.0")

Global Flags:
      --force-color   Force color output
      --no-color      Disable color output
  -q, --quiet         Show less output
      --timestamps    Enable timestamps in output
  -v, --verbose       Show more output

After

Usage:
  pack buildpack new <id> [flags]

Examples:
pack buildpack new sample/my-buildpack

Flags:
  -a, --api string        Buildpack API compatibility of the generated buildpack (default "0.8")
  -h, --help              Help for 'new'
  -p, --path string       Path to generate the buildpack
  -t, --targets strings   Targets are of the form 'os/arch/variant', for example 'linux/amd64' or 'linux/arm64/v9'. The full format for targets follows the form [os][/arch][/variant]:[distroname@osversion@anotherversion];[distroname@osversion]
                          	- Base case for two different architectures :  '--targets "linux/amd64" --targets "linux/arm64"'
                          	- case for distribution version: '--targets "windows/amd64:[email protected]"'
                          	- case for different architecture with distributed versions : '--targets "linux/arm/v6:[email protected]"  --targets "linux/arm/v6:[email protected]"'
                          	
  -V, --version string    Version of the generated buildpack (default "1.0.0")

Global Flags:
      --force-color   Force color output
      --no-color      Disable color output
  -q, --quiet         Show less output
      --timestamps    Enable timestamps in output
  -v, --verbose       Show more output

Documentation

  • Should this change be documented?
    • Yes, see #___
    • No

@gogolok gogolok requested review from a team as code owners December 2, 2024 14:36
@gogolok gogolok force-pushed the buildpack_new_help_wording branch from 815993e to 2efd635 Compare December 2, 2024 14:36
@gogolok gogolok changed the title Correct wording for buildpack new targerts flag Correct wording for buildpack new targets flag Dec 2, 2024
@github-actions github-actions bot added the type/enhancement Issue that requests a new feature or improvement. label Dec 2, 2024
@github-actions github-actions bot added this to the 0.37.0 milestone Dec 2, 2024
@gogolok gogolok force-pushed the buildpack_new_help_wording branch 3 times, most recently from d629f7a to 5330f96 Compare December 4, 2024 20:13
Signed-off-by: Robert Gogolok <[email protected]>
Co-authored-by: Aidan Delaney <[email protected]>
@gogolok gogolok force-pushed the buildpack_new_help_wording branch from 5330f96 to b689e6a Compare December 4, 2024 20:26
Copy link
Member

@jjbustamante jjbustamante left a comment

Choose a reason for hiding this comment

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

Thanks @gogolok

@jjbustamante jjbustamante merged commit 163db98 into buildpacks:main Dec 5, 2024
16 checks passed
@gogolok gogolok deleted the buildpack_new_help_wording branch December 5, 2024 22:19
@jjbustamante jjbustamante modified the milestones: 0.37.0, 0.36.1 Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants