We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 7b10f11 commit fe9abd9Copy full SHA for fe9abd9
src/memory_manager.rs
@@ -566,7 +566,12 @@ pub fn total_bytes<VM: VMBinding>(mmtk: &MMTK<VM>) -> usize {
566
mmtk.get_plan().get_total_pages() << LOG_BYTES_IN_PAGE
567
}
568
569
-/// Trigger a garbage collection as requested by the user. Returns whether a GC was ran or not.
+/// The application code has requested a collection. This is just a GC hint, and
570
+/// we may ignore it.
571
+///
572
+/// Returns whether a GC was ran or not. If MMTk triggers a GC, this method will block the
573
+/// calling thread and return true when the GC finishes. Otherwise, this method returns
574
+/// false immediately.
575
///
576
/// Arguments:
577
/// * `mmtk`: A reference to an MMTk instance.
0 commit comments