Bug 1730875 - Add documentation for search related preferences. r=daleharvey

Also remove a couple of unused/obsolete preferences.

Differential Revision: https://phabricator.services.mozilla.com/D134509

browser/components/search/docs/Preferences.rst

@@ -0,0 +1,28 @@
+Preferences
+===========
+
+This document describes preferences affecting Firefox's Search UI code. For information
+on the toolkit search service, see the :doc:`/toolkit/search/Preferences` document.
+Preferences that are generated and updated by code won't be described here.
+
+User Exposed
+------------
+These preferences are exposed through the Firefox UI
+
+browser.search.hiddenOneOffs (string, default: "")
+  A comma-separated list of search engines names that are hidden on the toolbar.
+
+browser.search.widget.inNavBar (boolean, default: false)
+  Whether the search bar widget is displayed in the navigation bar.
+
+Hidden
+------
+These preferences are normally hidden, and should not be used unless you really
+know what you are doing.
+
+browser.search.openintab (boolean, default: false)
+  Whether or not items opened from the search bar are opened in a new tab.
+
+browser.search.context.loadInBackground (boolean, default: false)
+  Whether or not tabs opened from searching in the context menu are loaded in
+  the foreground or background.

browser/components/search/docs/index.rst

@@ -16,6 +16,7 @@ Most of the search code lives in `browser/components/search`_.
 .. toctree::
 
    application-search-engines
+   Preferences
    telemetry
 
 .. _toolkit Search Service: /toolkit/search/index.html

modules/libpref/init/all.js

@@ -4111,8 +4111,6 @@ pref("dom.wakelock.enabled", false);
 // Search service settings
 pref("browser.search.log", false);
 pref("browser.search.update", true);
-pref("browser.search.update.log", false);
-pref("browser.search.update.interval", 21600);
 pref("browser.search.suggest.enabled", true);
 pref("browser.search.suggest.enabled.private", false);
 pref("browser.search.separatePrivateDefault", false);

toolkit/components/search/docs/Preferences.rst

@@ -0,0 +1,46 @@
+Preferences
+===========
+
+This document describes Preferences affecting the toolkit Search Service.
+Preferences that are generated and updated by code won't be described here.
+
+User Exposed
+------------
+These preferences are exposed through the Firefox UI.
+
+browser.search.suggest.enabled (default: true)
+  Whether search suggestions are enabled in the search bar. Turning this off
+  also currently prevents search suggestions in the address bar.
+
+Hidden
+------
+These preferences are normally hidden, and should not be used unless you really
+know what you are doing.
+
+browser.search.log (boolean, default: false)
+  Whether search service console logging is enabled or not.
+
+browser.search.suggest.timeout (number, default: 500)
+  When requesting suggestions from a search server, it has this long to respond.
+
+browser.search.update (boolean, default: true)
+  Whether updates are enabled for OpenSearch based engines. This only applies
+  to OpenSearch engines where their definition supplies an update url.
+  Note that this does not affect any of: application updates, add-on updates,
+  remote settings updates.
+
+Experimental
+------------
+These preferences are experimental and not officially supported. They could be
+removed at any time.
+
+browser.search.separatePrivateDefault.ui.enabled (boolean, default: false)
+  Whether the UI is enabled for having a separate default search engine in
+  private browsing mode.
+
+browser.search.separatePrivateDefault (boolean, default: false)
+  Whether the user has selected to have a separate default search engine in
+  private browsing mode.
+
+browser.search.suggest.enabled.private (boolean, default: false)
+  Whether search suggestions are enabled in a private browsing window.

toolkit/components/search/docs/index.rst

@@ -25,4 +25,5 @@ Contents
    SearchEngineConfiguration
    SearchConfigurationSchema
    DefaultSearchEngines
+   Preferences
    Telemetry