[DOC] Tweaks for GC.config

1 files changed, 9 insertions, 8 deletions

diff --git a/gc.rb b/gc.rb
index 54a88cf8f7..a7620fd9ac 100644
--- a/gc.rb
+++ b/gc.rb
@@ -260,11 +260,12 @@ module GC
   #     GC.config -> hash
   #     GC.config(hash_to_merge) -> merged_hash
   #
-  # This method is expected to be defined, useful, and well-behaved
-  # only in the CRuby implementation.
+  # This method is implementation-specific to CRuby.
   #
   # Sets or gets information about the current \GC configuration.
   #
+  # Configuration parameters are \GC implementation-specific and may change without notice.
+  #
   # With no argument given, returns a hash containing the configuration:
   #
   #   GC.config
@@ -302,13 +303,13 @@ module GC
   #   Controls whether the \GC is allowed to run a full mark (young & old objects):
   #
   #   - +true+ (default): \GC interleaves major and minor collections.
-  #   - +false+: \GC does not initiate a full marking cycle unless
-  #     explicitly directed by user code;
+  #     A flag is set to notify GC that a full mark has been requested.
+  #     This flag is accessible via GC.latest_gc_info(:need_major_by).
+  #   - +false+: \GC does not initiate a full marking cycle unless explicitly directed by user code;
   #     see GC.start.
-  #
-  #   Setting this parameter to +false+ disables young-to-old promotion .
-  #   For performance reasons, we recommended warming up the application using Process.warmup
-  #   before setting this parameter to +false+.
+  #     Setting this parameter to +false+ disables young-to-old promotion.
+  #     For performance reasons, we recommended warming up the application using Process.warmup
+  #     before setting this parameter to +false+.
   #
   def self.config hash = nil
     return Primitive.gc_config_get unless hash