google / google/gapid

gapit verb help text should describe positional arguments

Open
#2,686 0 comments 0 reactions 0 assignees View on GitHub
P3 triaged
Dominant language
Go
Stars
2.2k
Forks
329
PR merge metrics
No merged PRs in 30d

Description

Currently only flags are documented, e.g. `gapit benchmark` returns

```
GAPIT: GAPIT is a command line tool for the graphics api debugger system.
benchmark: Runs a set of benchmarking tests on an application
Usage: GAPIT benchmark [benchmark-flags]
benchmark-flags:
-additionalargs string
additional arguments to pass to the application
[...]
```

This says nothing about the positional argument of the verb, in that case the name of the process to run the benchmark on.

Also, running `gapit ` seem to print the help for that verb, this is not working with `benchmark`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.