-
Notifications
You must be signed in to change notification settings - Fork 57
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
Should --help text be consistently written to stdout? #689
Labels
Comments
@varungandhi-src Could you ask around in Slack to see what behavior people expect with this? Once we have that, we'll prioritize a fix. Thanks! |
Poll in Slack didn't gather a lot of data points:
|
I think the answers to this SO question are quite good and make sense:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For
src
CLI, it looks like help text with--help
is output to either stderr or a mix of stdout and stderr.For example,
src --help
seems to output everything to stderr.src lsif upload --help
seems to output some text to stdout and some to stderr.In either case, you need an extra
2&>1
if you want to pipe the output to a pager. My understanding is outputting help text to stderr is intentionally the default behavior for theflag
package. (golang/go#17284, https://cs.opensource.google/go/go/+/refs/tags/go1.17.5:src/flag/flag.go;l=369;drc=refs%2Ftags%2Fgo1.17.5)Since
src
is likely to be used by more non-Go developers compared to Go developers, would it make sense to consistently output the help text to stdout instead?The text was updated successfully, but these errors were encountered: