Skip to content

Should --help text be consistently written to stdout? #689

Open
@varungandhi-src

Description

@varungandhi-src

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 the flag 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?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions