Skip to content

Commit 84afbfa

Browse files
authored
[NFC][Doc] Update test-e2e/readme.md (#16967)
Add new sections to the table of contents and make them subsections.
1 parent b8a0742 commit 84afbfa

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

sycl/test-e2e/README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
* [Creating or modifying tests](#creating-or-modifying-tests)
1010
* [LIT feature checks](#lit-feature-checks)
1111
* [llvm-lit parameters](#llvm-lit-parameters)
12+
* [Marking tests as expected to fail](#marking-tests-as-expected-to-fail)
13+
* [Marking tests as unsupported](#marking-tests-as-unsupported)
1214
* [SYCL core header file](#sycl-core-header-file)
1315

1416
## Overview
@@ -301,23 +303,6 @@ llvm-lit --param dpcpp_compiler=path/to/clang++ --param dump_ir=True \
301303
SYCL/External/RSBench
302304
```
303305
304-
### SYCL core header file
305-
306-
While SYCL specification dictates that the only user-visible interface is
307-
`<sycl/sycl.hpp>` header file we found out that as the implementation and
308-
multiple extensions grew, the compile time was getting worse and worse,
309-
negatively affecting our CI turnaround time. As such, we decided to use
310-
finer-grained includes for the end-to-end tests used in this project (under
311-
`sycl/test-e2e/` folder).
312-
313-
At this moment all the tests have been updated to include a limited set of
314-
headers only. However, the work of eliminating unnecessary dependencies between
315-
implementation header files is still in progress and the final set of these
316-
"fine-grained" includes that might be officially documented and suggested for
317-
customers to use isn't determined yet. **Until then, code outside of this
318-
project must keep using `<sycl/sycl.hpp>` provided by the SYCL2020
319-
specification.**
320-
321306
### Marking tests as expected to fail
322307
323308
Every test should be written in a way that it is either passed, or it is skipped
@@ -382,6 +367,23 @@ non-standard mechanism. Use `UNSUPPORTED: true` instead, we track `UNSUPPORTED`
382367
tests using the mechanism described above. Otherwise the test risks remaining
383368
untraceable.
384369
370+
### SYCL core header file
371+
372+
While SYCL specification dictates that the only user-visible interface is
373+
`<sycl/sycl.hpp>` header file we found out that as the implementation and
374+
multiple extensions grew, the compile time was getting worse and worse,
375+
negatively affecting our CI turnaround time. As such, we decided to use
376+
finer-grained includes for the end-to-end tests used in this project (under
377+
`sycl/test-e2e/` folder).
378+
379+
At this moment all the tests have been updated to include a limited set of
380+
headers only. However, the work of eliminating unnecessary dependencies between
381+
implementation header files is still in progress and the final set of these
382+
"fine-grained" includes that might be officially documented and suggested for
383+
customers to use isn't determined yet. **Until then, code outside of this
384+
project must keep using `<sycl/sycl.hpp>` provided by the SYCL2020
385+
specification.**
386+
385387
### Compiling and executing tests on separate systems
386388
387389
The execution of e2e tests can be separated into compilation and execution

0 commit comments

Comments
 (0)