Skip to content

Commit b37b29e

Browse files
committed
website: improve documentation on build names in matrices
1 parent 9dbfcfb commit b37b29e

File tree

1 file changed

+2
-1
lines changed
  • website/content/docs/running-staticcheck/cli/build-tags

1 file changed

+2
-1
lines changed

website/content/docs/running-staticcheck/cli/build-tags/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,9 @@ This is useful when all configurations can be checked on a single system, for ex
134134

135135
When using the `-matrix` flag, Staticcheck reads a build matrix from standard input.
136136
The build matrix uses a line-based format, where each non-empty line specifies a build name, environment variables and command-line flags.
137-
A line is of the format `<name>: [environment variables] [flags]`, for example `linux-debug: GOOS=linux -tags=debug -some-flag="some value"`.
137+
A line is of the format `<name>: [environment variables] [flags]`, for example `linux_debug: GOOS=linux -tags=debug -some-flag="some value"`.
138138
Environment variables and flags get passed to `go` when Staticcheck analyzes code, so you can use all flags that `go` supports, such as `-tags` or `-gcflags`, although few flags other than `-tags` are really useful.
139+
Valid build names consist of letters, numbers and underscores.
139140

140141
Here is an example of using a build matrix:
141142

0 commit comments

Comments
 (0)