search

github / gh-ost

GitHub's Online Schema-migration Tool for MySQL
MIT License
12.44k stars 1.26k forks source link

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

Open dveeden opened 8 years ago

dveeden commented 8 years ago

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

shlomi-noach commented 8 years ago

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 https://github.com/github/gh-ost/pull/128, but... I'd like to see if we can have it otherwise.

zmoazeni commented 7 years ago

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 commented 7 years ago

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.