From e923dd3622be96eca030230de71fa5c78262f0be Mon Sep 17 00:00:00 2001 From: "Sebastien Rosset (serosset)" Date: Sun, 21 Feb 2021 13:41:19 +0000 Subject: [PATCH] add doc for the profiling arguments --- docs/src/docs/usage/configuration.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/docs/usage/configuration.mdx b/docs/src/docs/usage/configuration.mdx index 94a9a94ed818..4a18b51757de 100644 --- a/docs/src/docs/usage/configuration.mdx +++ b/docs/src/docs/usage/configuration.mdx @@ -19,6 +19,12 @@ golangci-lint run -h {.RunHelpText} ``` +When the `--cpu-profile-path` or `--mem-profile-path` arguments are specified, `golangci-lint` writes runtime profiling data +in the format expected by the [pprof](https://github.com/google/pprof) visualization tool. + +When the `--trace-path` argument is specified, `golangci-lint` writes runtime tracing data in the format expected by +the `go tool trace` command and visualization tool. + ## Config File GolangCI-Lint looks for config files in the following paths from the current working directory: