From 87c39667bf881527d4ddfe1c558fc98adb9543a0 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@ruby-lang.org>
Date: Sun, 9 Nov 2025 21:13:01 +0900
Subject: [PATCH] [DOC] ObjectSpace.trace_object_allocations_debug_start

---
 ext/objspace/object_tracing.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ext/objspace/object_tracing.c b/ext/objspace/object_tracing.c
index 0156642ef2..63eec67393 100644
--- a/ext/objspace/object_tracing.c
+++ b/ext/objspace/object_tracing.c
@@ -411,6 +411,13 @@ object_allocations_reporter(FILE *out, void *ptr)
     fprintf(out, "== object_allocations_reporter: END\n");
 }
 
+/*
+ * call-seq: trace_object_allocations_debug_start
+ *
+ * Starts tracing object allocations for GC debugging.
+ * If you encounter the BUG "... is T_NONE" (and so on) on your
+ * application, please try this method at the beginning of your app.
+ */
 static VALUE
 trace_object_allocations_debug_start(VALUE self)
 {