From 9b8825b6f94696c9659f93f5da9bf02644625f67 Mon Sep 17 00:00:00 2001
From: Aaron Patterson <tenderlove@ruby-lang.org>
Date: Fri, 29 May 2020 15:59:14 -0700
Subject: [PATCH] Update NEWS / documentation with GC.start(compact:true)

---
 NEWS.md | 8 ++++++++
 gc.rb   | 1 +
 2 files changed, 9 insertions(+)

diff --git a/NEWS.md b/NEWS.md
index 6856a29517..ea69498778 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -108,6 +108,14 @@ Outstanding ones only.
         * Symbol#to_proc now returns a lambda Proc.
           [[Feature #16260]]
 
+* GC
+
+    * Modified method
+
+        * GC.start now takes an option `compact: true` to compact the heap.
+          For example `GC.start(compact: true)` will have the same effect as
+          `GC.compact`.
+
 ## Stdlib updates
 
 Outstanding ones only.
diff --git a/gc.rb b/gc.rb
index 23ed12ffdc..881b8659ce 100644
--- a/gc.rb
+++ b/gc.rb
@@ -26,6 +26,7 @@ module GC
   #
   #  Use full_mark: false to perform a minor GC.
   #  Use immediate_sweep: false to defer sweeping (use lazy sweep).
+  #  Use compact: true to compact the heap (it implies a full mark and sweep).
   #
   #  Note: These keyword arguments are implementation and version dependent. They
   #  are not guaranteed to be future-compatible, and may be ignored if the