diff options
author | Mike McLaughlin <mikem@microsoft.com> | 2019-05-20 15:12:28 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-20 15:12:28 -0700 |
commit | f4ae8f0312890a7bc14c28764adb609820d86662 (patch) | |
tree | 7cd138af5e4f21ccc92a9572c0ca8ac91798e8fe | |
parent | df1b396c7a0da6cfddac9cd7236aa4187742126a (diff) | |
download | coreclr-f4ae8f0312890a7bc14c28764adb609820d86662.tar.gz coreclr-f4ae8f0312890a7bc14c28764adb609820d86662.tar.bz2 coreclr-f4ae8f0312890a7bc14c28764adb609820d86662.zip |
Comment the include files that have SOS dependencies (#24655)
Add warning headers
Issue https://github.com/dotnet/diagnostics/issues/38
-rw-r--r-- | src/inc/gcdecoder.cpp | 5 | ||||
-rw-r--r-- | src/inc/gcinfo.h | 5 | ||||
-rw-r--r-- | src/inc/gcinfodecoder.h | 6 | ||||
-rw-r--r-- | src/inc/gcinfodumper.h | 5 | ||||
-rw-r--r-- | src/inc/gcinfotypes.h | 5 | ||||
-rw-r--r-- | src/inc/stresslog.h | 7 |
6 files changed, 32 insertions, 1 deletions
diff --git a/src/inc/gcdecoder.cpp b/src/inc/gcdecoder.cpp index a2a2e8ccd5..ed3f1f34d7 100644 --- a/src/inc/gcdecoder.cpp +++ b/src/inc/gcdecoder.cpp @@ -13,6 +13,11 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX */ +// ****************************************************************************** +// WARNING!!!: This code is also used by SOS in the diagnostics repo. Should be +// updated in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/gcdecoder.cpp +// ****************************************************************************** #ifdef _TARGET_X86_ diff --git a/src/inc/gcinfo.h b/src/inc/gcinfo.h index 901f2cfc07..acdfe6589a 100644 --- a/src/inc/gcinfo.h +++ b/src/inc/gcinfo.h @@ -2,6 +2,11 @@ // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. +// ****************************************************************************** +// WARNING!!!: These values are used by SOS in the diagnostics repo. Values should +// added or removed in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/gcinfo.h +// ****************************************************************************** /*****************************************************************************/ #ifndef _GCINFO_H_ diff --git a/src/inc/gcinfodecoder.h b/src/inc/gcinfodecoder.h index e8fe6b9523..dfaa3b16ae 100644 --- a/src/inc/gcinfodecoder.h +++ b/src/inc/gcinfodecoder.h @@ -8,6 +8,12 @@ * *****************************************************************/ +// ****************************************************************************** +// WARNING!!!: These values are used by SOS in the diagnostics repo. Values should +// added or removed in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/gcinfodecoder.h +// ****************************************************************************** + #ifndef _GC_INFO_DECODER_ #define _GC_INFO_DECODER_ diff --git a/src/inc/gcinfodumper.h b/src/inc/gcinfodumper.h index 296dd29543..cd939c1340 100644 --- a/src/inc/gcinfodumper.h +++ b/src/inc/gcinfodumper.h @@ -8,6 +8,11 @@ #include "gcinfotypes.h" #include "gcinfodecoder.h" +// ***************************************************************************** +// WARNING!!!: These values and code are also used by SOS in the diagnostics +// repo. Should updated in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/gcinfodumper.h +// ***************************************************************************** // // This class dumps the contents of the gc encodings, providing outputs diff --git a/src/inc/gcinfotypes.h b/src/inc/gcinfotypes.h index ac82dfb2fc..6abf0890c8 100644 --- a/src/inc/gcinfotypes.h +++ b/src/inc/gcinfotypes.h @@ -10,6 +10,11 @@ #include "gcinfo.h" #endif +// ***************************************************************************** +// WARNING!!!: These values and code are also used by SOS in the diagnostics +// repo. Should updated in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/gcinfotypes.h +// ***************************************************************************** #define PARTIALLY_INTERRUPTIBLE_GC_SUPPORTED diff --git a/src/inc/stresslog.h b/src/inc/stresslog.h index 8f98f9a7b2..8e509e5f4e 100644 --- a/src/inc/stresslog.h +++ b/src/inc/stresslog.h @@ -17,7 +17,12 @@ /* The log has a very simple structure, and it meant to be dumped from a NTSD extention (eg. strike). There is no memory allocation system calls etc to purtub things */ -/* see the tools/strike/stressdump.cpp for the dumper utility that parses this log */ +// ****************************************************************************** +// WARNING!!!: These classes are used by SOS in the diagnostics repo. Values should +// added or removed in a backwards and forwards compatible way. +// See: https://github.com/dotnet/diagnostics/blob/master/src/inc/stresslog.h +// Parser: https://github.com/dotnet/diagnostics/blob/master/src/SOS/Strike/stressLogDump.cpp +// ****************************************************************************** /*************************************************************************************/ |