~john-koepi/ubuntu/trusty/golang/default

« back to all changes in this revision

Viewing changes to debian/man/go-testflag.7

  • Committer: Package Import Robot
  • Author(s): Ondřej Surý, Ondřej Surý, Michael Stapelberg
  • Date: 2012-06-28 12:14:15 UTC
  • mfrom: (1.1.15)
  • mto: (3.1.5 experimental) (14.3.1 saucy)
  • mto: This revision was merged to the branch mainline in revision 24.
  • Revision ID: package-import@ubuntu.com-20120628121415-w1b0076ixkarr1ml
[ Ondřej Surý ]
* Imported Upstream version 1.0.2
* Update Vcs fields to reflect new git repository location
* Kill get-orig-source, since 1.0.0, the tarballs can be downloaded
  from webpage

[ Michael Stapelberg ]
* golang-mode: use debian-pkg-add-load-path-item (Closes: #664802)
* Add manpages (Closes: #632964)
* Use updated pt.po from Pedro Ribeiro (Closes: #674958)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"                                      Hey, EMACS: -*- nroff -*-
 
2
.de Vb \" Begin verbatim text
 
3
.ft CW
 
4
.nf
 
5
.ne \\$1
 
6
..
 
7
.de Ve \" End verbatim text
 
8
.ft R
 
9
.fi
 
10
..
 
11
.TH GO-TESTFLAG 7 "2012-05-13"
 
12
.\" Please adjust this date whenever revising the manpage.
 
13
.SH NAME
 
14
go \- tool for managing Go source code
 
15
.SH DESCRIPTION
 
16
The 'go test' command takes both flags that apply to 'go test' itself
 
17
and flags that apply to the resulting test binary.
 
18
 
 
19
The test binary, called pkg.test, where pkg is the name of the
 
20
directory containing the package sources, has its own flags:
 
21
 
 
22
.TP
 
23
.B \-test.v
 
24
Verbose output: log all tests as they are run.
 
25
.TP
 
26
.B \-test.run pattern
 
27
Run only those tests and examples matching the regular expression.
 
28
.TP
 
29
.B \-test.bench pattern
 
30
Run benchmarks matching the regular expression.
 
31
By default, no benchmarks run.
 
32
.TP
 
33
.B \-test.cpuprofile cpu.out
 
34
Write a CPU profile to the specified file before exiting.
 
35
.TP
 
36
.B \-test.memprofile mem.out
 
37
Write a memory profile to the specified file when all tests
 
38
are complete.
 
39
.TP
 
40
.B \-test.memprofilerate n
 
41
Enable more precise (and expensive) memory profiles by setting
 
42
runtime.MemProfileRate.  See 'godoc runtime MemProfileRate'.
 
43
To profile all memory allocations, use \-test.memprofilerate=1
 
44
and set the environment variable GOGC=off to disable the
 
45
garbage collector, provided the test can run in the available
 
46
memory without garbage collection.
 
47
.TP
 
48
.B \-test.parallel n
 
49
Allow parallel execution of test functions that call t.Parallel.
 
50
The value of this flag is the maximum number of tests to run
 
51
simultaneously; by default, it is set to the value of GOMAXPROCS.
 
52
.TP
 
53
.B \-test.short
 
54
Tell long-running tests to shorten their run time.
 
55
It is off by default but set during all.bash so that installing
 
56
the Go tree can run a sanity check but not spend time running
 
57
exhaustive tests.
 
58
.TP
 
59
.B \-test.timeout t
 
60
If a test runs longer than t, panic.
 
61
.TP
 
62
.B \-test.benchtime n
 
63
Run enough iterations of each benchmark to take n seconds.
 
64
The default is 1 second.
 
65
.TP
 
66
.B \-test.cpu 1,2,4
 
67
Specify a list of GOMAXPROCS values for which the tests or
 
68
benchmarks should be executed.  The default is the current value
 
69
of GOMAXPROCS.
 
70
.P
 
71
For convenience, each of these \-test.X flags of the test binary is
 
72
also available as the flag \-X in 'go test' itself.  Flags not listed
 
73
here are passed through unaltered.  For instance, the command
 
74
 
 
75
.Vb 6
 
76
\&      go test \-x \-v \-cpuprofile=prof.out \-dir=testdata \-update
 
77
.Ve
 
78
 
 
79
will compile the test binary and then run it as
 
80
 
 
81
.Vb 6
 
82
\&      pkg.test \-test.v \-test.cpuprofile=prof.out \-dir=testdata \-update
 
83
.Ve
 
84
.SH AUTHOR
 
85
.PP
 
86
This manual page was written by Michael Stapelberg <stapelberg@debian.org>,
 
87
for the Debian project (and may be used by others).