1716610 - Slightly confusing help text for GCHashMap

Status: RESOLVED FIXED

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

Description

[Steve Fink [:sfink] [:s:]]

I was helping someone with a rooting hazard who read the GCHashMap comment

// itself cause tracing or sweeping to be invoked. For tracing, it must be used
// with Rooted or PersistentRooted, or barriered and traced manually. For
// sweeping, currently it requires an explicit call to <map>.sweep().

as meaning that you need to pass a Rooted into GCHashMap::add(). That interpretation reveals further misunderstandings of what's going on, but a minor change would at least prevent falling off the right path at this particular spot.

Comment 1

[Steve Fink [:sfink] [:s:]]

Attachment: Bug 1716610 - Prevent misinterpretation of GCHashMap + Rooted

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/33b6cad5e3b0
Prevent misinterpretation of GCHashMap + Rooted r=jonco DONTBUILD

Comment 3

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/33b6cad5e3b0