added docstring

Diogo Netto · Diogo Netto · commit 25eefda0693d · 2023-01-23T16:26:30.000-05:00
diff --git a/src/gc.c b/src/gc.c
@@ -777,7 +777,7 @@ STATIC_INLINE void gc_queue_big_marked(jl_ptls_t ptls, bigval_t *hdr,
     ptls->gc_cache.nbig_obj = nobj + 1;
 }
 
-// TODO: write docstring
+// Atomically set the mark bit for object and return whether it was previously unmarked
 FORCE_INLINE int gc_try_setmark_tag(jl_taggedvalue_t *o, uint8_t mark_mode) JL_NOTSAFEPOINT
 {
     assert(gc_marked(mark_mode));

Original file line number	Diff line number	Diff line change
`@@ -777,7 +777,7 @@ STATIC_INLINE void gc_queue_big_marked(jl_ptls_t ptls, bigval_t *hdr,`
`777`	`777`	`ptls->gc_cache.nbig_obj = nobj + 1;`
`778`	`778`	`}`
`779`	`779`
`780`		`-// TODO: write docstring`
	`780`	`+// Atomically set the mark bit for object and return whether it was previously unmarked`
`781`	`781`	`FORCE_INLINE int gc_try_setmark_tag(jl_taggedvalue_t *o, uint8_t mark_mode) JL_NOTSAFEPOINT`
`782`	`782`	`{`
`783`	`783`	`assert(gc_marked(mark_mode));`