Skip to content

Commit 1c86ccb

Browse files
authored
Update CONTRIBUTION.md for path to slang-test.exe (shader-slang#4619)
The path to slang-test.exe has been changed recently and it needs to be updated on the document.
1 parent 24f8999 commit 1c86ccb

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTION.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ Make your changes and ensure to follow our [Design Decisions](docs/design/README
111111
### Testing
112112
Test your changes thoroughly to ensure they do not introduce new issues. This is done by building and running a "slang-test" from the repository root directory. For more details about "slang-test", please refer to a [Documentation on testing](tools/slang-test/README.md).
113113

114+
> Note: slang-test is meant to launch from the root of the repository. It uses a hard-coded directory name "tests/" that is expected to exist in the current working directory.
115+
114116
> Note: One of the options for `slang-test.exe` is `-api`, and it takes an additional keyword to specify which API to test. When the option is `-api all-cpu`, as an example, it means it tests all APIs except CPU. The minus sign (-) after `all` means "exclude" and you can "include" with plus sign (+) like `-api gl+dx11`.
115117
116118
If you are familiar with Workflow/Actions in github, you can check [Our Workflows](.github/workflows). "Test Slang" section in [ci.yml](.github/workflows/ci.yml) is where "slang-test" runs.
@@ -125,7 +127,7 @@ For a quick reference, follow the instructions below.
125127
```
126128
1. Run slang-test with multiple threads. This may take 10 minutes or less depending on the performance of your computer.
127129
```
128-
C:\git\slang> bin\windows-x64\release\slang-test.exe -use-test-server -server-count 8
130+
C:\git\slang> build\Release\bin\slang-test.exe -use-test-server -server-count 8
129131
```
130132
> Note: if you increase `-server-count` more than 16, you may find some of tests randomly fail. This is a known issue on the graphics driver side.
131133
1. Check whether the test is finished as expected.
@@ -138,7 +140,7 @@ For a quick reference, follow the instructions below.
138140
```
139141
1. Run slang-test with multiple threads. This may take 10 minutes or less depending on the performance of your computer.
140142
```
141-
$ ./bin/linux-x64/release/slang-test -use-test-server -server-count 8
143+
$ ./build/Release/bin/slang-test -use-test-server -server-count 8
142144
```
143145
1. Check whether the test is finished as expected.
144146

0 commit comments

Comments
 (0)