1704992 - AnnotateCrashReport doc says "may only be called from the main thread in a content process", is it still correct?

Status: RESOLVED FIXED

(Toolkit :: Crash Reporting, defect)

Description

[Gerald Squelart (he/him) (not at Mozilla since 2022-09-15)]

bug 1614933 removed the check that AnnotateCrashReport is only called from the main thread in content processes.
Since there is a mutex in the function, this gives the impression that it could now be called from anywhere.
However the documentation above the function declaration still says:

// AnnotateCrashReport, RemoveCrashReportAnnotation and
// AppendAppNotesToCrashReport may be called from any thread in a chrome
// process, but may only be called from the main thread in a content process.

I'm guessing the documentation should be updated to remove the restriction. Unless it's still correct, in which case I think the assertion should be re-added to catch misuses.

NI:Gabriele, you wrote that patch, what do you think? Thank you.

Comment 1

[Gabriele Svelto [:gsvelto]]

I forgot to update the comment. Calling those functions is safe in any process and in any thread now.

Comment 2

[Gabriele Svelto [:gsvelto]]

Attachment: Bug 1704992 - Update the comment about crash annotations to reflect the current state of things r=gerald

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d33df94d95ee
Update the comment about crash annotations to reflect the current state of things r=gerald DONTBUILD

Comment 4

[Dorel Luca [:dluca]]

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