[SYCL][Doc] Clarify environment variables documentation #4640
Conversation
alexbatashev
requested review from
romanovvlad,
pvchupin,
smaslov-intel and
s-kanaev
| | -------------------- | ------ | ----------- | | ||
| | `SYCL_ENABLE_PCI` | Integer | When set to 1, enables obtaining the GPU PCI address when using the Level Zero backend. The default is 0. | | ||
| | `SYCL_PI_LEVEL_ZERO_DISABLE_USM_ALLOCATOR` | Any(\*) | Disable USM allocator in Level Zero plugin (each memory request will go directly to Level Zero runtime) | | ||
| | `SYCL_PI_LEVEL_ZERO_TRACK_INDIRECT_ACCESS_MEMORY` | Any(\*) | Enable support of the kernels with indirect access and corresponding deferred release of memory allocations in the Level Zero plugin. | |
There was a problem hiding this comment.
@smaslov-intel
Could you please tell if we have tests for this variable(couldn't find such)? If no, probably we need to move it to "debugging" section until we have proper testing.
There was a problem hiding this comment.
@againull : did you add a test?
sycl/doc/EnvironmentVariables.md
Outdated
|
|
||
| **Warning:** the environment variables described below are used for | ||
| development and debugging of DPC++ compiler and runtime. Their semantics are | ||
| subject to change. Do not rely on these variables in production code. |
There was a problem hiding this comment.
Maybe it would stop more people from using these vars if we say that they may have bugs that we may refuse to fix. :)
There was a problem hiding this comment.
They're not bugs, they're undefined behavior
sycl/doc/EnvironmentVariables.md
Outdated
|
|
||
| ## Debugging variables for DPC++ Runtime | ||
|
|
||
| **Warning:** the environment variables described below are used for |
There was a problem hiding this comment.
Can we highlight this warning more? Red text or some warning icon?
There was a problem hiding this comment.
This blocks color painting on github: github/markup#1440 (but it'll work for rendered docs)
But github supports emojis, so I added one
sycl/doc/EnvironmentVariables.md
Outdated
| **Warning:** the environment variables described below are used for | ||
| development and debugging of DPC++ compiler and runtime. Their semantics are | ||
| subject to change. Do not rely on these variables in production code. |
This patch splits up environment variables into 4 categories, to make it clear, which variables are not supposed to be used in production and only serve for debugging purpose.