[runtime] Add some documentation for the offsets stuff.

[mono.git] / mono / mini / mini-cross-helpers.c

diff --git a/mono/mini/mini-cross-helpers.c b/mono/mini/mini-cross-helpers.c
index 28e04d6d6288388a8ca141a481b7262cd1b7ea5a..6c6ead8c4d2e204cd451f913386fccb891100e0f 100644 (file)
--- a/mono/mini/mini-cross-helpers.c
+++ b/mono/mini/mini-cross-helpers.c
@@ -44,6 +44,12 @@ mono_dump_jit_offsets (void)
 #endif
 }
 
+/*
+ * mono_cross_helpers_run:
+ *
+ *   Check that the offsets given by object-offsets.h match the offsets
+ * on the host.
+ */
 void
 mono_cross_helpers_run (void)
 {
@@ -59,6 +65,7 @@ mono_cross_helpers_run (void)
 #if defined (HAS_CROSS_COMPILER_OFFSETS) && !defined (MONO_CROSS_COMPILE)
        mono_metadata_cross_helpers_run ();
 
+       /* The metadata offsets are already checked above */
 #define DISABLE_METADATA_OFFSETS
 #define USE_CROSS_COMPILE_OFFSETS
 #define DECL_OFFSET(struct,field) this_should_not_happen_for_cross_fields