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

Consistency in named arguments #98

Open
supakeen opened this issue Jan 25, 2025 · 1 comment
Open

Consistency in named arguments #98

supakeen opened this issue Jan 25, 2025 · 1 comment
Labels
🪄 enhancement New feature or request

Comments

@supakeen
Copy link
Member

supakeen commented Jan 25, 2025

We have a few arguments that all deal with filesystem paths:

  1. --blueprint
  2. --datadir
  3. --output-dir

These either have dir, -dir, or nothing special in the name. I'd like to make them predictable and my suggestion is to drop the dir and -dir parts of the names. So we get:

  1. --blueprint
  2. --data
  3. --output

Thoughts? --data might be a bit terse and in general is pretty non-descriptive; perhaps --defs suits better to align with the name that seems to be the one we want in images?

--output clashes with the --output on list-images, I'd suggest renaming that one to --format.

A full command line would then look like (for example):

image-builder build --defs=~/my-defs --blueprint=foo.toml --output=/opt/build qcow2
@supakeen supakeen added the 🪄 enhancement New feature or request label Jan 25, 2025
@supakeen
Copy link
Member Author

Demo implementation in #99 so it can be tried out to see how it feels; each change as a separate commit so they can be cherry-picked for those we like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🪄 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant