luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2025-04-03 18:30:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix incorrect comment in lgc.h (#1288)

Browse source 
The comment gave an incorrect (reversed) version of the invariant, which
could be confusing for people who haven't read the full description in
lgc.cpp.

Unfortunately this change is difficult to flag.

Fixes #1282.
This commit is contained in:
Arseny Kapoulkine 2024-06-07 11:56:00 -05:00 • committed by GitHub
parent 43bf7c4e05
commit 23b8726203
Signed by: DevComp
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
VM/src/lgc.h
View file

@ -23,11 +23,10 @@
#define GCSsweep 4
/*
** macro to tell when main invariant (white objects cannot point to black
** ones) must be kept. During a collection, the sweep
** phase may break the invariant, as objects turned white may point to
** still-black objects. The invariant is restored when sweep ends and
** all objects are white again.
** The main invariant of the garbage collector, while marking objects,
** is that a black object can never point to a white one. This invariant
** is not being enforced during a sweep phase, and is restored when sweep
** ends.
*/
#define keepinvariant(g) ((g)->gcstate == GCSpropagate || (g)->gcstate == GCSpropagateagain || (g)->gcstate == GCSatomic)