Browse code

update HACKING.md

Steve Kuznetsov authored on 2015/08/11 02:07:52
Showing 1 changed files
... ...
@@ -135,9 +135,13 @@ Run the integration tests with:
135 135
     $ hack/test-integration.sh
136 136
 
137 137
 The script launches an instance of etcd and then invokes the integration tests. If you need to
138
-execute an individual test start etcd and then run:
138
+execute a subset of integration tests, run:
139 139
 
140
-    $ hack/test-go.sh test/integration -tags 'integration no-docker' -test.run=TestBuildClient
140
+    $ hack/test-integration.sh <regex>
141
+    
142
+Where `<regex>` is some regular expression that matches the names of all of the tests you want to run.
143
+The regular expression is passed into `grep -E`, so ensure that the syntax or features you use are supported.
144
+The default regular expression used is `Test`, which matches all tests.
141 145
 
142 146
 Each integration function is executed in its own process so that it cleanly shuts down any background
143 147
 goroutines. You will not be able to run more than a single test within a single process.
... ...
@@ -343,7 +347,8 @@ OpenShift integrates the go `pprof` tooling to make it easy to capture CPU and h
343 343
   * `mem` - generate a running heap dump that tracks allocations to `./mem.pprof`
344 344
   * `web` - start the pprof webserver in process at http://127.0.0.1:6060/debug/pprof (you can open this in a browser)
345 345
 
346
-    # start the server in CPU profiling mode
346
+In order to start the server in CPU profiling mode, run: 
347
+
347 348
     $ OPENSHIFT_PROFILE=cpu sudo ./_output/local/go/bin/openshift start
348 349
 
349 350
 To view profiles, you use [pprof] which is part of `go tool`.  You must pass the binary you are debugging (for symbols) and a captured pprof.  For instance, to view a `cpu` profile from above, you would run OpenShift to completion, and then run:
... ...
@@ -384,4 +389,4 @@ Finally, when using the `web` profile mode, you can have the go tool directly fe
384 384
     # for a snapshot heap dump at the current time, showing total allocations
385 385
     $ go tool pprof --alloc_space ./_output/local/go/bin/openshift http://127.0.0.1:6060/debug/pprof/heap
386 386
 
387
-See [debugging Go programs](https://golang.org/pkg/net/http/pprof/) for more info.  `pprof` has many modes and is very powerful (try `tree`) - you can pass a regex to many arguments to limit your results to only those samples that match the regex (basically the function name or the call stack).
388 387
\ No newline at end of file
388
+See [debugging Go programs](https://golang.org/pkg/net/http/pprof/) for more info.  `pprof` has many modes and is very powerful (try `tree`) - you can pass a regex to many arguments to limit your results to only those samples that match the regex (basically the function name or the call stack).