aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/go/alldocs.go
diff options
context:
space:
mode:
authorEnrico Candino <enrico.candino@gmail.com>2023-05-26 00:52:57 +0200
committerGopher Robot <gobot@golang.org>2023-05-27 02:24:47 +0000
commit7ad92e95b56019083824492fbec5bb07926d8ebd (patch)
treea1a62e9b4938ae80c42192d7355d0ded85bc3287 /src/cmd/go/alldocs.go
parentccc42b0f91a7fc44b0353dea3f302f79fb28b300 (diff)
downloadgo-7ad92e95b56019083824492fbec5bb07926d8ebd.tar.gz
go-7ad92e95b56019083824492fbec5bb07926d8ebd.zip
cmd/go: update cover flag documentation
Cover flag documentation was not up to date, and the -covermode flag documentation was missing. Fixes #60438 Change-Id: I11e769fa2a32d074de7a748aa534afdfe2ca4e78 Reviewed-on: https://go-review.googlesource.com/c/go/+/498415 TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Than McIntosh <thanm@google.com> Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Diffstat (limited to 'src/cmd/go/alldocs.go')
-rw-r--r--src/cmd/go/alldocs.go14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go
index 46466fd5c85..4124eef78ad 100644
--- a/src/cmd/go/alldocs.go
+++ b/src/cmd/go/alldocs.go
@@ -127,8 +127,17 @@
// Supported only on linux/amd64 or linux/arm64 and only with GCC 7 and higher
// or Clang/LLVM 9 and higher.
// -cover
-// enable code coverage instrumentation (requires
-// that GOEXPERIMENT=coverageredesign be set).
+// enable code coverage instrumentation.
+// -covermode set,count,atomic
+// set the mode for coverage analysis.
+// The default is "set" unless -race is enabled,
+// in which case it is "atomic".
+// The values:
+// set: bool: does this statement run?
+// count: int: how many times does this statement run?
+// atomic: int: count, but correct in multithreaded tests;
+// significantly more expensive.
+// Sets -cover.
// -coverpkg pattern1,pattern2,pattern3
// For a build that targets package 'main' (e.g. building a Go
// executable), apply coverage analysis to each package matching
@@ -142,7 +151,6 @@
// do not delete it when exiting.
// -x
// print the commands.
-//
// -asmflags '[pattern=]arg list'
// arguments to pass on each go tool asm invocation.
// -buildmode mode