1
0
mirror of https://github.com/google/gops.git synced 2025-02-19 19:59:55 +02:00

Improve the help text (#94)

Avoid using tabs, remove help from "subcommands" list,
don't differentiate the profiling commands from others.
This commit is contained in:
JBD 2019-08-01 22:19:10 -07:00 committed by GitHub
parent 6cdc0c0a4a
commit 59c8be2ead
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

30
main.go
View File

@ -23,26 +23,24 @@ import (
const helpText = `gops is a tool to list and diagnose Go processes.
gops <cmd> <pid|addr> ...
gops <pid> # displays process info
Usage:
gops <cmd> <pid|addr> ...
gops <pid> # displays process info
gops help # displays this help message
Commands:
stack Prints the stack trace.
gc Runs the garbage collector and blocks until successful.
setgc Sets the garbage collection target percentage.
memstats Prints the allocation and garbage collection stats.
version Prints the Go version used to build the program.
stats Prints the vital runtime stats.
help Prints this help text.
Profiling commands:
trace Runs the runtime tracer for 5 secs and launches "go tool trace".
pprof-heap Reads the heap profile and launches "go tool pprof".
pprof-cpu Reads the CPU profile and launches "go tool pprof".
stack Prints the stack trace.
gc Runs the garbage collector and blocks until successful.
setgc Sets the garbage collection target percentage.
memstats Prints the allocation and garbage collection stats.
version Prints the Go version used to build the program.
stats Prints runtime stats.
trace Runs the runtime tracer for 5 secs and launches "go tool trace".
pprof-heap Reads the heap profile and launches "go tool pprof".
pprof-cpu Reads the CPU profile and launches "go tool pprof".
All commands require the agent running on the Go process.
Symbol "*" indicates the process runs the agent.`
"*" indicates the process is running the agent.`
// TODO(jbd): add link that explains the use of agent.