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

Add -v/--version argument and output in usage #87

Open
mlavi opened this issue Jan 2, 2022 · 3 comments
Open

Add -v/--version argument and output in usage #87

mlavi opened this issue Jan 2, 2022 · 3 comments

Comments

@mlavi
Copy link

mlavi commented Jan 2, 2022

Thank you for OpenDoas, after just an hour, I appreciate it over my sudoers.d/* pains!

I just reviewed this repo's releases and couldn't find a simple manner via doas output or even the man pages to figure what version I had installed, hence the request!

It seems this project adopts short argument flags, so in that spirit, I'd like to request a -v flag to output the OpenDoas version. Alternatively, or in addition, I'd like the OpenDoas version reported on it's own line in the usage output.

Likewise, some enhancements come to mind past the request above, happy to break into their own issues if that's deemed better!

  • Bonus: add the repo's releases URL on its own line to the usage and version outputs.
  • Small bonus: adding both to the man pages.

Without any other project guidance, I intuit the pragmatic work effort to minimize the porting from upstream that adding long flags such as --version would imply, but wondered if that's a discussion or design decision that may want to be vocalized somewhere. I've seen other projects adopt GH Discussions to keep issues focused for that reason and document design decisions under an /architecture repo or subdirectory and mention this in a /CONTRIBUTING.md document or equivalent.

Thanks again and happy new year!

@Duncaen
Copy link
Owner

Duncaen commented Jan 16, 2022

I don't want to add new flags as they could later clash with upstream changes, the only alternative would be to add long flags as mentioned, but since that requires more changes for not that much value, I don't think this is something I would do.

Is there a reason you need a version flag to retrieve the version of installed software instead of using a package manager?

@mlavi
Copy link
Author

mlavi commented Jan 17, 2022

If all package managers could be trusted for consistency and version parity across OSs, sure!

Because AlpineLInux.org is deprecating sudo and has adopted OpenDoas, I came here to learn more and then install it on it other OSs and would want to maintain version parity. It didn't help that the man page is the BSD version and doesn't refer to OpenDoas and such that the package name, command, man page, and project repo match.

I'm griping because I have become accustomed to easy version discovery from the binary output behind some flag (sometimes even -h for help) and it hadn't occurred to me to look at package info. Your points are valid: he package info suffices and I agree the effort for a new flag is not worthwhile.

However, improving version discovery and project URL via man page and/or help output would certainly be helpful.

@DonielMoins
Copy link

I would love to see this implemented. Small 'feature' that would simplify debugging issues.

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