1517684 - Out of date comment for FinalizeArenas

Status: RESOLVED FIXED

(Core :: JavaScript: GC, enhancement, P3)

Description

[Paul Bone [:pbone]]

https://searchfox.org/mozilla-central/source/js/src/gc/GC.cpp#672-678

The comment here refers to al's cursor.  al no longer exists and the list of arenas here doesn't have a cursor.  I'm not sure how to update this comment due to the missing cursor.

Comment 1

[Paul Bone [:pbone]]

NI jonco because I think he last edited this code.

Comment 2

[Jon Coppeard (:jonco)]

The cursor it's referring to is src, a pointer to an Arena pointer.  This got renamed a while back but the comment wasn't updated.

Comment 3

[Paul Bone [:pbone]]

(In reply to Jon Coppeard (:jonco) from comment #2)
> The cursor it's referring to is src, a pointer to an Arena pointer.  This
> got renamed a while back but the comment wasn't updated.

The comment says that on return the cursor points to the first non-empty arena.  I don't see how that works, because the loop exits when *src is null (or if it's over budget).  Maybe I should just remove that bit?

Comment 4

[Jon Coppeard (:jonco)]

(In reply to Paul Bone [:pbone] from comment #3)
> The comment says that on return the cursor points to the first non-empty
> arena.  I don't see how that works, because the loop exits when *src is null
> (or if it's over budget).  Maybe I should just remove that bit?

Oh, I see.  You're right, on return src points to null if we've finished or the next arena to process.

Comment 5

[Paul Bone [:pbone]]

Attachment: Bug 1517684 - Fix obsolete comment

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/e9bc92a2ff28
Fix obsolete comment

Comment 7

[Eliza Balazs [:ebalazs_]]

https://hg.mozilla.org/mozilla-central/rev/e9bc92a2ff28