intel / intel/compute-runtime

[GSD-11616] Create the documentation for environment variables

Open
#484 2 comments 3 reactions 0 assignees View on GitHub
Status: Backlog Type: Feature Request
Dominant language
C++
Stars
1.4k
Forks
300
PR merge metrics
No merged PRs in 30d

Description

Hi,
It was found that if I want to find some definition for environment variables from [the list](https://github.com/intel/compute-runtime/blob/master/shared/source/debug_settings/debug_variables_base.inl), I need to go over the list and try to not break eyes looking at the list and try to guess what is the real definition is :)

Could you please create any human-friendly documentation (.md, github pages or something else) that can contain clear definitions for variables?
Example:
instead of `DECLARE_DEBUG_VARIABLE(int32_t, RenderCompressedBuffersEnabled, -1, "-1: default, 0: disabled, 1: enabled")`
let's have
| RenderCompressedBuffersEnabled | what it does, how the behavior is changed | -1 (default value) | possible values with meaning |

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.