Skip to content

Commit 7138b80

Browse files
authored
Revise toolchaintest/README.md (#2565)
1 parent 7f73590 commit 7138b80

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

‎toolchaintest/README.md‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
1-
# Toolchain Tests
1+
# Toolchain tests
22

3-
Tests for Microsoft-specific Go toolchain behavior, kept outside the upstream Go patch set. The repository's build and CI test runners run this module alongside the upstream tests.
3+
This module tests Microsoft-specific Go toolchain behavior.
4+
It's maintained outside the upstream Go patch set.
5+
The repository's build and CI test runners run this module alongside the upstream tests.
46

5-
After [building the toolchain](../eng/doc/DeveloperGuide.md#build-the-go-toolchain), run from this directory:
7+
After [building the toolchain](../eng/doc/DeveloperGuide.md#build-the-go-toolchain), run this command from the current directory:
68

79
```sh
810
../go/bin/go test -count=1
911
```
1012

11-
On Windows, use `..\go\bin\go.exe`.
13+
On Windows:
1214

13-
The CLI tests default to the Go executable in the running test binary's GOROOT. To use a different toolchain, including when running the tests with a bootstrap Go installation:
15+
```pwsh
16+
..\go\bin\go.exe test -count=1
17+
```
18+
19+
By default, the CLI tests use the Go executable in the test binary's `GOROOT`.
20+
To use a different toolchain, such as when you run the tests with a bootstrap Go installation, specify the Go executable:
1421

1522
```sh
1623
go test -count=1 -go=/path/to/microsoft-go/bin/go
1724
```
1825

19-
The public `go/build` API tests use the toolchain that compiles the test binary. Run the module with the built Microsoft Go executable to test both APIs and CLI behavior with that toolchain.
26+
The public `go/build` API tests use the toolchain that compiled the test binary.
27+
Run the module with the built Microsoft build of Go executable to test the API and CLI behavior of that toolchain.
2028

21-
The module has no external dependencies. It covers system-crypto build tags, cross-compilation, build information, and FIPS-mode command behavior.
29+
The module has no external dependencies.
30+
It tests system-crypto build tags, cross-compilation, build information, and FIPS-mode command behavior.

0 commit comments

Comments
 (0)