From: Noah Falk Date: Thu, 3 Sep 2020 21:07:37 +0000 (-0700) Subject: Add COMPlus env var comment docs (#41707) X-Git-Tag: submit/tizen/20210909.063632~5642 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=68d96f1de86bb1dc247971326228611e3a0c7f05;p=platform%2Fupstream%2Fdotnet%2Fruntime.git Add COMPlus env var comment docs (#41707) We lost our docs at some point, but the key detail is that prepending COMPlus_ to the knob name is the environment variable you need to set. Hoisting that fact right to the top of the file so that people who come looking can find it. --- diff --git a/src/coreclr/src/inc/clrconfigvalues.h b/src/coreclr/src/inc/clrconfigvalues.h index cad4f8b..56483b0 100644 --- a/src/coreclr/src/inc/clrconfigvalues.h +++ b/src/coreclr/src/inc/clrconfigvalues.h @@ -8,6 +8,17 @@ // Unified method of accessing configuration values from environment variables, // registry and config file. // +// Given any config knob below that looks like this example: +// RETAIL_CONFIG_DWORD_INFO_DIRECT_ACCESS(INTERNAL_LogEnable, W("LogEnable"), "Turns on the traditional CLR log.") +// --------- +// | +// -------------------- +// | +// V +// You can set an environment variable COMPlus_LogEnable=1 to enable it. +// +// See below for more details +// //***************************************************************************** // IMPORTANT: Before adding a new config value, please read up on naming conventions (see