aerokube / cm

Configuration manager for Aerokube products

https://aerokube.com/cm/latest/

Apache License 2.0

119 stars 31 forks source link

Update CM command doc with relevant syntax #220

Closed plagov closed 5 years ago

plagov commented 5 years ago

In the latest stable version of the CM binary, if arguments are enclosed with the square brackets, then these arguments are ignored. They have to be put within quotes. Also, add an example of the --config-dir command.

codecov[bot] commented 5 years ago

Codecov Report

Merging #220 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #220   +/-   ##
=======================================
  Coverage   73.09%   73.09%           
=======================================
  Files           4        4           
  Lines        1156     1156           
=======================================
  Hits          845      845           
  Misses        208      208           
  Partials      103      103

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 0f155a8...1ed0039. Read the comment docs.

vania-pooh commented 5 years ago

@plagov square brackets in the majority of Unix documentations means optional argument. It never worked with square brackets, we mean these arguments can be omitted.

plagov commented 5 years ago

@vania-pooh oh, I didn't know that. When I was setting up the Selenoid with CM I expected these commands to be copy-pasteable, so I decided to improve documentation on that. Probably it will be helpful for others.

But it's up to you, of course, to decide with this PR.

And thanks a lot for developing this great product!

vania-pooh commented 5 years ago

@plagov ok, let me think how to improve this. You are not the first person facing with unclear commands.

vania-pooh commented 5 years ago

Will be fixed in #239.