827444 - Clarify compatibility warning for nsIPrefBranch2

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: Compatibility Tools, defect)

Description

[Dave Garrett]

+++ This bug was initially created as a clone of Bug #752747 +++

The AMO addon validator has the following warning for usage of nsIPrefBranch2:

------------------------------------------------------------
Warning: This add-on uses nsIPrefBranch2, which has been merged into nsIPrefBranch in Gecko 13. Once you drop support for old versions of Gecko, you should stop using nsIPrefBranch2. You can use the == operator as an alternative.

See bug https://bugzilla.mozilla.org/show_bug.cgi?id=718255 for more information.

------------------------------------------------------------

What exactly does "You can use the == operator as an alternative" mean? nsIPrefBranch2 just provided observer registration prior to being built-into nsIPrefBranch. Did this bit of text get copied accidentally from another warning or am I missing something here? In either case, please clarify the text in this warning.

https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsIPrefBranch
https://developer.mozilla.org/en-US/docs/XPCOM_Interface_Reference/nsIPrefBranch2

Comment 1

[Jorge Villalobos [:jorgev] (he/him)]

Ugh, that was my bad. I must have copied that sentence from a different compatibility warning.

Assigning to Basta, but also adding Kris in case he can produce a quick patch for it.

Comment 2

[Matt Basta [:basta]]

Is this just a matter of removing that sentence?

Comment 3

[Kris Maglione [:kmag]]

Yes.

Comment 4

[Matt Basta [:basta]]

https://github.com/mozilla/amo-validator/commit/5dd905fa39a8a0a6e2389ecd1842a0e2af3f8f7e

Comment 5

[Kris Maglione [:kmag]]

Thanks.