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

Mix of --<option> and -<option> #127

Open
dveeden opened this issue Aug 3, 2016 · 3 comments
Open

Mix of --<option> and -<option> #127

dveeden opened this issue Aug 3, 2016 · 3 comments

Comments

@dveeden
Copy link
Contributor

dveeden commented Aug 3, 2016

The output of gh-ost --help shows short options like -database in go-style.
However gh-ost without options shows 2016-08-03 09:16:34 FATAL --database must be provided and database name must not be empty with --database instead.

Let's settle for the go-style one-dash options instead of the GNU style long options.
This prevents the later use Unix style short options, but that should be fine

dveeden added a commit to dveeden/gh-ost that referenced this issue Aug 3, 2016
Also change references to `gh-osc` to `gh-ost`. In README.md there
is one reference left, but that's to describe the history.

Related Issue: github#127
@shlomi-noach
Copy link
Contributor

Oh I'm so ambivalent about this. While I realize this is a golang project, I really do like adhering to unix-style --long-options.

Given that

The output of gh-ost --help shows short options like -database in go-style

it makes sense to approve #128, but... I'd like to see if we can have it otherwise.

@zmoazeni
Copy link
Contributor

zmoazeni commented Sep 6, 2017

This really confused me using the --help. Personally I'm in favor of using the double dash since that's a bit more standard. But I don't have a strong preference.

However, having documentation+help consistent would be a great.

@zmoazeni
Copy link
Contributor

zmoazeni commented Sep 7, 2017

it makes sense to approve #128, but... I'd like to see if we can have it otherwise.

Does this mean you'd prefer the opposite of 128? As in, instead of changing the documentation, change the output of --help to double dash?

I can take a stab at that PR if so.

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