nsIPrefBranch::prefHasUserValue should document the fact that a pref no longer has a user set value if it is set to its default value

RESOLVED FIXED

Status

()

--
major
RESOLVED FIXED
13 years ago
12 years ago

People

(Reporter: darin.moz, Assigned: asqueella)

Tracking

Trunk
Points:
---

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 1 obsolete attachment)

(Reporter)

Description

13 years ago
nsIPrefBranch::prefHasUserValue should document the fact that a pref no longer has a user set value if it is set to its default value.

This "hidden" behavior of the pref system has been the source of numerous bugs.  We should at least document the behavior so people will have a fighting chance of not continuously tripping over this.

Comment 1

13 years ago
Have we considered changing the behavior of the pref system to save explicitly-set userprefs even if they match the default?
(Reporter)

Comment 2

13 years ago
I think that has been discussed, but nsIPrefBranch is a frozen interface.  We'd have to be really careful about changing this "feature" of the pref system.
(Assignee)

Comment 3

12 years ago
Created attachment 249861 [details] [diff] [review]
patch
Assignee: prefs → asqueella
Status: NEW → ASSIGNED
Attachment #249861 - Flags: superreview?(darin.moz)
Attachment #249861 - Flags: review?(darin.moz)
(Reporter)

Comment 4

12 years ago
Comment on attachment 249861 [details] [diff] [review]
patch

>Index: modules/libpref/public/nsIPrefBranch.idl

>+   * considered reset to it's default value.

you meant "its"


r+sr=darin
Attachment #249861 - Flags: superreview?(darin.moz)
Attachment #249861 - Flags: superreview+
Attachment #249861 - Flags: review?(darin.moz)
Attachment #249861 - Flags: review+
(Assignee)

Comment 5

12 years ago
Created attachment 249908 [details] [diff] [review]
for checkin

Oops.
Attachment #249861 - Attachment is obsolete: true
(Assignee)

Updated

12 years ago
Whiteboard: [checkin needed]

Comment 6

12 years ago
Checking in mozilla/modules/libpref/public/nsIPrefBranch.idl;
/cvsroot/mozilla/modules/libpref/public/nsIPrefBranch.idl,v  <--  nsIPrefBranch.idl
new revision: 1.20; previous revision: 1.19
done
Status: ASSIGNED → RESOLVED
Last Resolved: 12 years ago
Resolution: --- → FIXED
Whiteboard: [checkin needed]
You need to log in before you can comment on or make changes to this bug.