Closed Bug 328128 Opened 18 years ago Closed 18 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

Categories

(Core :: Preferences: Backend, defect)

defect
Not set
major

Tracking

()

RESOLVED FIXED

People

(Reporter: darin.moz, Assigned: asqueella)

Details

Attachments

(1 file, 1 obsolete file)

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.
Have we considered changing the behavior of the pref system to save explicitly-set userprefs even if they match the default?
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.
Attached patch patch (obsolete) — Splinter Review
Assignee: prefs → asqueella
Status: NEW → ASSIGNED
Attachment #249861 - Flags: superreview?(darin.moz)
Attachment #249861 - Flags: review?(darin.moz)
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+
Attached patch for checkinSplinter Review
Oops.
Attachment #249861 - Attachment is obsolete: true
Whiteboard: [checkin needed]
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
Closed: 18 years ago
Resolution: --- → FIXED
Whiteboard: [checkin needed]
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: