fix stale docstring in gc_sweep_page (#54743)

d-netto · web-flow · commit 8a7d8f444ace · 2024-06-09T18:50:56.000-03:00
diff --git a/src/gc.c b/src/gc.c
@@ -1432,7 +1432,8 @@ STATIC_INLINE void gc_dump_page_utilization_data(void) JL_NOTSAFEPOINT
 
 int64_t buffered_pages = 0;
 
-// Returns pointer to terminal pointer of list rooted at *pfl.
+// Walks over a page, reconstruting the free lists if the page contains at least one live object. If not,
+// queues up the page for later decommit (i.e. through `madvise` on Unix).
 static void gc_sweep_page(gc_page_profiler_serializer_t *s, jl_gc_pool_t *p, jl_gc_page_stack_t *allocd, jl_gc_page_stack_t *buffered,
                           jl_gc_pagemeta_t *pg, int osize) JL_NOTSAFEPOINT
 {

Original file line number	Diff line number	Diff line change
`@@ -1432,7 +1432,8 @@ STATIC_INLINE void gc_dump_page_utilization_data(void) JL_NOTSAFEPOINT`
`1432`	`1432`
`1433`	`1433`	`int64_t buffered_pages = 0;`
`1434`	`1434`
`1435`		`-// Returns pointer to terminal pointer of list rooted at *pfl.`
	`1435`	`+// Walks over a page, reconstruting the free lists if the page contains at least one live object. If not,`
	`1436`	+// queues up the page for later decommit (i.e. through `madvise` on Unix).
`1436`	`1437`	`static void gc_sweep_page(gc_page_profiler_serializer_t s, jl_gc_pool_t p, jl_gc_page_stack_t allocd, jl_gc_page_stack_t buffered,`
`1437`	`1438`	`jl_gc_pagemeta_t *pg, int osize) JL_NOTSAFEPOINT`
`1438`	`1439`	`{`