compute-runtime icon indicating copy to clipboard operation
compute-runtime copied to clipboard

Create the documentation for environment variables

Open andreyfe1 opened this issue 3 years ago • 2 comments

Hi, It was found that if I want to find some definition for environment variables from the list, 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 |

andreyfe1 avatar Dec 17 '21 12:12 andreyfe1

@capatober : Thanks. We are currently thinking on how to add some more documentation, which will include further explanation on the most important debug keys. We will provide an update here once we have something well defined.

jandres742 avatar Jan 21 '22 06:01 jandres742

We are slowly updating the descriptions to be clearer. We do not intend to publish standalone documentation for debug keys.

AdamCetnerowski avatar Nov 24 '22 08:11 AdamCetnerowski