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

Inconsistent option help style between our command line tools. #46

Open
ximon18 opened this issue Dec 3, 2024 · 2 comments
Open

Inconsistent option help style between our command line tools. #46

ximon18 opened this issue Dec 3, 2024 · 2 comments

Comments

@ximon18
Copy link
Member

ximon18 commented Dec 3, 2024

dnst command help uses lowercase single words to document command line options, while dnsi uses SNAKE_CASE.

One of our older more mature Rust products, Routinator, also uses the lowercase single word option style.

We should decide if we want consistency and if so with what? With our own Rust tools? With our earlier non-Rust tools? With other tools in the ecosystem?

Switching to lowercase single word option style for dnsi would at least make dnsi, dnst and routinator consistent with each other, but I note that even our RPKI tooling is not consistent as rtrtr uses UPPERCASE single word option style while krill and krillcuse lowercase single word option style (with the exception of URI).

@Philip-NLnetLabs
Copy link
Member

Historical Unix seems to be single word in lowercase. Unbound has only one option with an argument and it is listed as a lowercase word. NSD has plenty of options with arguments. In some cases a hyphen is used as in 'server-count'.

@tertsdiepraam
Copy link
Contributor

Another data point:

$ ls --help
...
      --block-size=SIZE      with -l, scale sizes by SIZE when printing them;
...
      --time-style=TIME_STYLE
...

I really don't care as long as it's consistent across all domain-based tools.

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

No branches or pull requests

3 participants