Comment the include files that have SOS dependencies (dotnet/coreclr#24655)

Add warning headers

Issue https://github.com/dotnet/diagnostics/issues/38

Commit migrated from https://github.com/dotnet/coreclr/commit/f4ae8f0312890a7bc14c28764adb609820d86662

diff --git a/src/coreclr/src/inc/gcdecoder.cpp b/src/coreclr/src/inc/gcdecoder.cpp
index a2a2e8c..ed3f1f3 100644 (file)
--- a/src/coreclr/src/inc/gcdecoder.cpp
+++ b/src/coreclr/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/coreclr/src/inc/gcinfo.h b/src/coreclr/src/inc/gcinfo.h
index 901f2cf..acdfe65 100644 (file)
--- a/src/coreclr/src/inc/gcinfo.h
+++ b/src/coreclr/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/coreclr/src/inc/gcinfodecoder.h b/src/coreclr/src/inc/gcinfodecoder.h
index e8fe6b9..dfaa3b1 100644 (file)
--- a/src/coreclr/src/inc/gcinfodecoder.h
+++ b/src/coreclr/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/coreclr/src/inc/gcinfodumper.h b/src/coreclr/src/inc/gcinfodumper.h
index 296dd29..cd939c1 100644 (file)
--- a/src/coreclr/src/inc/gcinfodumper.h
+++ b/src/coreclr/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/coreclr/src/inc/gcinfotypes.h b/src/coreclr/src/inc/gcinfotypes.h
index ac82dfb..6abf089 100644 (file)
--- a/src/coreclr/src/inc/gcinfotypes.h
+++ b/src/coreclr/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/coreclr/src/inc/stresslog.h b/src/coreclr/src/inc/stresslog.h
index 8f98f9a..8e509e5 100644 (file)
--- a/src/coreclr/src/inc/stresslog.h
+++ b/src/coreclr/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
+// ******************************************************************************
 
 /*************************************************************************************/