theforeman/foreman-documentation

Decide on foreman-installer "--option=true" vs --option true"

Opened this issue · 4 comments

maximiliankolb commented

original comment: https://github.com/theforeman/foreman-documentation/pull/2825/files#r1521916088

Tested successfully on Foreman 3.9:

$ foreman-installer --foreman-proxy-dhcp true
$ foreman-installer --foreman-proxy-dhcp=true

I propose that we pick one way over the other and make it consistent throughout the docs.

adamlazik1 commented

I'd probably prefer = to be more explicit. No strong opinions, though.

asteflova commented

I like = too. Subjectively, it seems to me that it makes the connection between the option and the value obvious at first glance.

For the sake of completeness: I tried to find an objective reason to pick one over the other by searching the style guides we use d/s, but I didn't find any guidance there.

Lennonka commented

I would prefer a space, because it makes it visually easier to scan the command line.

ekohl commented

I vaguely recall that for hash arguments the = handling was broken. So passing --my-hash-argument key:value would work but --my-hash-argument=key:value wouldn't. However, I can't find a bug report on that.