summaryrefslogtreecommitdiff
path: root/src/cmd/cov/doc.go
blob: 5de00e19cda52e201c257136612d6e42e9c9ad47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

/*

Cov is a rudimentary code coverage tool.

Given a command to run, it runs the command while tracking which
sections of code have been executed.  When the command finishes,
cov prints the line numbers of sections of code in the binary that
were not executed.   With no arguments it assumes the command "6.out".

Usage: cov [-lsv] [-g substring] [-m minlines] [6.out args]

The options are:

	-l
		print full path names instead of paths relative to the current directory
	-s
		show the source code that didn't execute, in addition to the line numbers.
	-v
		print debugging information during the run.
	-g substring
		restrict the coverage analysis to functions or files whose names contain substring
	-m minlines
		only report uncovered sections of code larger than minlines lines

For reasons of disambiguation it is installed as 6cov although it also serves
as an 8cov and a 5cov.

*/
package documentation