From 13e834307b2605b5669be5e90b24df9a93469f58 Mon Sep 17 00:00:00 2001 From: Ivan Maidanski Date: Fri, 4 Aug 2017 01:09:34 +0300 Subject: [PATCH] Refine collect_a_little documentation (better explain when 0 is returned) Issue #64 (bdwgc). * include/gc.h (GC_collect_a_little): Refine comment. --- include/gc.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/gc.h b/include/gc.h index d3838697..9c1406fc 100644 --- a/include/gc.h +++ b/include/gc.h @@ -789,7 +789,8 @@ GC_API int GC_CALL GC_is_incremental_mode(void); GC_API int GC_CALL GC_incremental_protection_needs(void); /* Perform some garbage collection work, if appropriate. */ -/* Return 0 if there is no more work to be done. */ +/* Return 0 if there is no more work to be done (including the */ +/* case when garbage collection is not appropriate). */ /* Typically performs an amount of work corresponding roughly */ /* to marking from one page. May do more work if further */ /* progress requires it, e.g. if incremental collection is */ -- 2.40.0