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

Change help to distinguish mandatory parameters from optional parameters #144

Merged
merged 4 commits into from
Apr 30, 2016

Conversation

moogle19
Copy link
Contributor

Change the help output to a 'zfs' command style output,
where mandatory parameters are in angle brackets and optional
parameters in brackets.

Change the help output to a 'zfs' command style output,
where mandatory parameters are in angle brackets and optional
parameters in brackets.
@moogle19
Copy link
Contributor Author

The setup command is kind of strange, because it can have any combination of the arguments (pool, net and/or kmod) but should require at least one of them. I am not quite sure how to express that.

@pr1ntf
Copy link
Owner

pr1ntf commented Apr 25, 2016

This looks good, and you handle the setup function properly. However, we should also add this to the help output in the README.md file and the iohyve.8.txt & iohyve.8 man pages.

You can read how we turn the iohyve.8.txt file into a man page here.

Also note, I am going to try and get your library move merged before merging this PR.

Keep up the good work! 👍

@pr1ntf
Copy link
Owner

pr1ntf commented Apr 30, 2016

Looking good 😎

@pr1ntf pr1ntf merged commit cba799b into pr1ntf:master Apr 30, 2016
@moogle19 moogle19 deleted the cleanup_help branch April 30, 2016 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants