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

Turn --authfile into an alias for --auth-file #20693

Open
mtrmac opened this issue Nov 15, 2023 · 3 comments
Open

Turn --authfile into an alias for --auth-file #20693

mtrmac opened this issue Nov 15, 2023 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@mtrmac
Copy link
Collaborator

mtrmac commented Nov 15, 2023

Feature request description

As discussed in containers/common#1731 , we will have login --authfile vs. login --compat-auth-file; it would be better to be consistent everywhere; and --authfile unnecessarily concatenates words.

Suggest potential solution

In c/{common,buildah,podman,skopeo}: replace all existing --authfile options by an --auth-file spelling, and keep --authfile as an alias.

@mtrmac mtrmac added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 15, 2023
@Luap99
Copy link
Member

Luap99 commented Nov 15, 2023

I tend to prefer option names with words separated by - so this sounds fine in principle to me but I think @rhatdan is/was a strong opponent of them.

But in general my question would be what value a rename of such a widespread options adds, this certainly leads to some confusion on how the option is really named if you see both variants used in the wild. There are old docs, scripts, etc...
Given we are going to have to keep --authfile supported anyway I am not sure what value --auth-file actually adds here besides improving the name a tiny bit.

@rhatdan
Copy link
Member

rhatdan commented Nov 16, 2023

I don't like large named options mainly for the amount of typing. I know completions help this out some, but not for scripts. I believe for ease of use the shorter the option name the better. I really hate sentence names for options.

But I do like consistency, haveing --authfile and --compat-auth-file is not good. Making these consistent, is the goal. So go either way.

@rhatdan
Copy link
Member

rhatdan commented Nov 16, 2023

man ls
...
--dereference-command-line-symlink-to-dir

Yuck, as an example. Good luck typing that option correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants