1741713 - Migrate "nsIPrefService" MDN doc to Firefox Source Docs

Status: RESOLVED INCOMPLETE

(Developer Infrastructure :: Source Documentation, task, P3)

Description

[Tim Giles [:tgiles]]

The missing document is located at https://github.com/mdn/archived-content/blob/main/files/en-us/mozilla/tech/xpcom/reference/interface/nsiprefservice/index.html and is needed for the testing overview doc in Bug 1736870.

Here are instructions on how to convert this archive document into the format needed for Firefox Source Docs.

If you have not contributed to Firefox before, please read the following sections of this quick start guide (note, you do not need to download the Firefox source code for this bug but feel free to):

• Before you start
• To write a patch
• To submit a patch

If you do not download the Firefox source code, you will need to ensure moz-phab is installed, otherwise you will not be able to submit your path. You can learn more about this process following the Mozilla Phabricator user guide

Comment 1

[BugBot [:suhaib / :marco/ :calixte]]

The Bugbug bot thinks this bug should belong to the 'Firefox Build System::Documentation Infrastructure' component, and is moving the bug to that component. Please revert this change in case you think the bot is wrong.

Comment 2

[Mathew Hodson]

Do you think having this page is still necessary? it mostly just duplicates the comments at https://searchfox.org/mozilla-central/source/modules/libpref/nsIPrefService.idl, and the comments there are more likely to be up to date.

I feel like anything that linked to this page could link to the interface on Searchfox instead.

Comment 3

[Tim Giles [:tgiles]]

Yeah, that's a valid point. The context for needing this nsIPrefService doc is covered by the nsIPrefService.idl file since the main testing doc (Bug 1736870) makes a simple reference to the nsIPrefService doc:

If the test runs in chrome scope (e.g mochitest chrome or browser-chrome), you can use Services.prefs to set the prefs in your test's setup function

I'm going to close this and the bug that is dependent on this doc for now. The storage documentation might be useful later but I have no need for it if this nsIPrefService bug goes away.