Remove several doc comments

This is being done as part of the docs migration process.

librewolf-community/librewolf-community.gitlab.io#2

1 files changed, 39 insertions, 236 deletions

diff --git a/settings/librewolf.cfg b/settings/librewolf.cfg
index a0311f5..11a44bd 100644
--- a/settings/librewolf.cfg
+++ b/settings/librewolf.cfg
@@ -1,7 +1,8 @@
-// ============================================================================================================================================
+// =====================================================================================
 //
 // LibreWolf
-// ============================================================================================================================================
+//
+// =====================================================================================
 // Documentation .............. :
 // ==============================
 //
@@ -25,21 +26,21 @@
 // "clearPref"      : Can be used to "blank" certain preferences. This can be useful e.g. to disable functions
 //                    that rely on comparing version numbers.
 //
-// ============================================================================================================================================
+// ====================================================================================
 // Protection ................. :
 // ==============================
 //
 // Pref             : Locking librewolf.cfg itself
 lockPref("general.config.filename", "librewolf.cfg");
 //
-// ============================================================================================================================================
+// =====================================================================================
 // Index librewolf.cfg .......... :
 // ==============================
 //
 // -----------------------------------------------------------------------
 // Section : User settings                    // Bench Diff : +0    / 5000
 // Section : Defaulting Settings              // Bench Diff : +0    / 5000
-// -------------------------------------------
+// -----------------------------------------------------------------------
 // Section : Controversial                    // Bench Diff : +0    / 5000
 // Section : Firefox Fingerprint              // Bench Diff : +0    / 5000
 // Section : Locale/Time                      // Bench Diff : +0    / 5000
@@ -48,27 +49,27 @@ lockPref("general.config.filename", "librewolf.cfg");
 // Section : IJWY To Shut Up                  // Bench Diff : +0    / 5000
 // Section : Microsoft Windows                // Bench Diff : +0    / 5000
 // Section : Firefox ESR60.x                  // Bench Diff : +0    / 5000
-// -------------------------------------------
+// -----------------------------------------------------------------------
 // Section : Security 1/3                     // Bench Diff : +0    / 5000
 // Section : Security 2/3                     // Bench Diff : +0    / 5000
 // Section : Security 3/3 (Cipher)            // Bench Diff : +0    / 5000
-// -------------------------------------------
+// -----------------------------------------------------------------------
 // Section : Performance 1/5                  // Bench Diff : +650  / 5000
 // Section : Performance 2/5                  // Bench Diff : -800  / 5000
 // Section : Performance 3/5                  // Bench Diff : -1720 / 5000
 // Section : Performance 4/5                  // Bench Diff : -200  / 5000
 // Section : Performance 5/5                  // Bench Diff : -50   / 5000
-// -------------------------------------------
+// -----------------------------------------------------------------------
 // Section : General Settings 1/3             // Bench Diff : +100  / 5000
 // Section : General Settings 2/3             // Bench Diff : +0    / 5000
 // Section : General Settings 3/3             // Bench Diff : -40   / 5000
-// -------------------------------------------
+// -----------------------------------------------------------------------
 // Section : Disabled - ON/OFF                // Bench Diff : +0    / 5000
 // Section : Disabled - Deprecated Active     // Bench Diff : +0    / 5000
 // Section : Disabled - Deprecated Inactive   // Bench Diff : +0    / 5000
 // -----------------------------------------------------------------------
 //
-// ============================================================================================================================================
+// -----------------------------------------------------------------------
 // Index local-settings.js .... :
 // ==============================
 //
@@ -76,12 +77,12 @@ lockPref("general.config.filename", "librewolf.cfg");
 // Section : General Settings                 // Bench Diff : ++    / 5000
 // -----------------------------------------------------------------------
 //
-// ============================================================================================================================================
+// -----------------------------------------------------------------------
 
-// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+// >>>>>>>>>>>>>>>>>>>>>>>
 // Section : User Settings
 // Bench Diff : +0/5000
-// >>>>>>>>>>>>>>>>>>>>
+// >>>>>>>>>>>>>>>>>>>>>>>
 
 // Librefox Compatibility Fix
 user_pref("extensions.autoDisableScopes", 0);
@@ -89,303 +90,105 @@ user_pref("extensions.autoDisableScopes", 0);
 // Removing https-everywhere adding 2 librefox addons
 user_pref("extensions.enabledAddons", "librefox.http.watcher.tor%40intika.be:2.8,%7Befd1ce61-97d1-4b4f-a378-67d0d41d858d%7D:1.2,%7B73a6fe31-595d-460b-a920-fcc0f8843232%7D:2.6.6.1,torbutton%40torproject.org:1.5.2,ubufox%40ubuntu.com:2.6,tor-launcher%40torproject.org:0.1.1pre-alpha,%7B972ce4c6-7e08-4474-a285-3208198ce6fd%7D:17.0.5");
 
-
-// ----------------------------------------------------------------------------------------------------
+// --------------------------------
 // User Settings : Cookies settings
-// ----------------------------------------------------------------------------------------------------
+// --------------------------------
 
-// Pref : Accept Only 1st Party Cookies
-// http://kb.mozillazine.org/Network.cookie.cookieBehavior#1
-// Blocking 3rd-party cookies breaks a number of payment gateways
-// CIS 2.5.1
 lockPref("network.cookie.cookieBehavior", 1);
-
-// Pref : Cookies expire at the end of the session (when the browser closes)
-// http://kb.mozillazine.org/Network.cookie.lifetimePolicy#2
-// 0=until they expire (default)
-// 2=until you close Firefox
-// 3=for n days
 lockPref("network.cookie.lifetimePolicy", 2);
+lockPref("network.cookie.same-site.enabled", true);
+lockPref("network.cookie.leave-secure-alone", true);
+lockPref("network.cookie.thirdparty.sessionOnly", true);
+lockPref("network.cookie.thirdparty.nonsecureSessionOnly", true);
 
-// Pref : Disable Cookie Exception Button
-// WARNING Bug !!! This locks the button regardless of its value
-//lockPref("pref.privacy.disable_button.cookie_exceptions", false);
+// -----------------------------------
+// User Settings : Tracking protection
+// -----------------------------------
 
-// Pref : 2706: enable support for same-site cookies (FF60+)
-// [1] https://bugzilla.mozilla.org/795346
-// [2] https://blog.mozilla.org/security/2018/04/24/same-site-cookies-in-firefox-60/
-// [3] https://www.sjoerdlangkemper.nl/2016/04/14/preventing-csrf-with-samesite-cookie-attribute/
-lockPref("network.cookie.same-site.enabled", true); // default: true
-
-// Pref : 2705: disable HTTP sites setting cookies with the "secure" directive (FF52+)
-// [1] https://developer.mozilla.org/Firefox/Releases/52#HTTP
-lockPref("network.cookie.leave-secure-alone", true); // default: true
-
-// Pref : 2702: set third-party cookies (i.e ALL) (if enabled, see above pref) to session-only
-// and (FF58+) set third-party non-secure (i.e HTTP) cookies to session-only
-// [NOTE] .sessionOnly overrides .nonsecureSessionOnly except when .sessionOnly=false and
-// nonsecureSessionOnly=true. This allows you to keep HTTPS cookies, but session-only HTTP ones
-// [1] https://feeding.cloud.geek.nz/posts/tweaking-cookies-for-privacy-in-firefox/
-// [2] http://kb.mozillazine.org/Network.cookie.thirdparty.sessionOnly
-lockPref("network.cookie.thirdparty.sessionOnly", true); // default : false
-lockPref("network.cookie.thirdparty.nonsecureSessionOnly", true); // (FF58+) // default false
-
-// Also check "User Settings : Track Protection" for other cookies settings
-
-// ----------------------------------------------------------------------------------------------------
-// User Settings : Track Protection (Integrated disconnect.me settings like uBlock)
-// ----------------------------------------------------------------------------------------------------
-
-// Pref : Track Protection
-// Firefox now integrates a tracking protection feature (based on disconnect.me).
-// It is a light-list content blocking; the list can not be edited. This feature
-// is disabled in LibreWolf. it's recommended to use ublock instead.
-// This feature is disabled :
-// - Until it evolves and integrates at least list editing
-// - Because double filtering (this + ublock) is not good for performance.
-
-// Pref : Track Protection
 lockPref("privacy.trackingprotection.enabled", false);
-
-// Pref : 0425: disable passive Tracking Protection (FF53+)
-// Passive TP annotates channels to lower the priority of network loads for resources
-// on the tracking protection list
-// [NOTE] It has no effect if TP is enabled, but keep in mind that by default TP is
-// enabled only in Private Windows
-// This is included for people who want to completely disable Tracking Protection.
-// [1] https://bugzilla.mozilla.org/buglist.cgi?bug_id=1170190,1141814
 lockPref("privacy.trackingprotection.annotate_channels", false);
 lockPref("privacy.trackingprotection.lower_network_priority", false);
 lockPref("privacy.trackingprotection.pbmode.enabled", false);
-
-// Pref : Changing block list (Tracking protection)
-// Default value "test-track-simple,base-track-digest256"
 lockPref("urlclassifier.trackingTable", "");
-// As tracking protection is disabled the button is disabled as well
 lockPref("pref.privacy.disable_button.change_blocklist", true);
-
-// Pref : contentblocking reportBreakage
 lockPref("browser.contentblocking.reportBreakage.enabled", false);
 lockPref("browser.contentblocking.reportBreakage.url", "");
 lockPref("browser.contentblocking.rejecttrackers.reportBreakage.enabled", false);
-
-// Pref : Third-party cookie ui under preferences
-lockPref("browser.contentblocking.rejecttrackers.ui.enabled", false); //This hides third-party cookie ui
-// Should lock third-party cookie ui, but third-party cookies are blocked too
-
-// Pref : Disable tracking protection ui list editing under url bar popup
+lockPref("browser.contentblocking.rejecttrackers.ui.enabled", false);
 lockPref("browser.contentblocking.trackingprotection.control-center.ui.enabled", false);
-
-// Pref : Disable tracking protection ui list editing under preferences
 lockPref("browser.contentblocking.trackingprotection.ui.enabled", false);
-
-// Pref : Other unnecessary CB/TP UI
 //lockPref("browser.contentblocking.global-toggle.enabled", false);
 //lockPref("browser.contentblocking.rejecttrackers.ui.recommended", false);
 //lockPref("browser.contentblocking.fastblock.ui.enabled", false);
 //lockPref("browser.contentblocking.fastblock.control-center.ui.enabled", false);
-
-// Pref : Tracking Protection Exception List
 //lockPref("browser.contentblocking.allowlist.annotations.enabled", false);
 //lockPref("browser.contentblocking.allowlist.storage.enabled", false);
-
-// Pref : Disable exception button (does not work as expected)
 //lockPref("pref.privacy.disable_button.tracking_protection_exceptions", false);
-// This seems to only disable the button; not suitable
-
-// Pref : Third-party cookie ui under url bar
 //lockPref("browser.contentblocking.rejecttrackers.control-center.ui.enabled", false);
-// This disables third-party cookie ui under url bar
-// This is disabled to leave icon in url bar
-
-// Pref : Disable TP UI
 //lockPref("browser.contentblocking.ui.enabled", false);
-// Fully disable CB/TP ui, this is disabled to leave icon in url bar
-
-// Pref : 0426 : Enforce Content Blocking (required to block cookies) (FF63+)
-// Master switch for all content blocking features (includes tracking protection,
-// but excludes tracking annotations annotate_channels).
-//lockPref("browser.contentblocking.enabled", false); // default: true
-// Other settings already regulate this section's sub-settings (this master switch
-// is not suitable).
-// Disabled because it is needed for blocking third party cookies
+//lockPref("browser.contentblocking.enabled", false);
 
-// ----------------------------------------------------------------------------------------------------
-// User Settings : Auto play settings
-// ----------------------------------------------------------------------------------------------------
+// ----------------------------------
+// User Settings : Auto-play settings
+// ----------------------------------
 
-// Pref : 2030: disable auto-play of HTML5 media (FF63+)
-// 0=Allowed (default), 1=Blocked, 2=Prompt
-// [SETUP-WEB] This may break video playback on various sites
 lockPref("media.autoplay.default", 2);
 
-// ----------------------------------------------------------------------------------------------------
+// -----------------------------------------
 // User Settings : Password manager settings
-// ----------------------------------------------------------------------------------------------------
+// -----------------------------------------
 
-// Pref : Disable password manager
-// CIS Version 1.2.0 October 21st, 2011 2.5.2
-lockPref("signon.rememberSignons", false); // policies "OfferToSaveLogins": false,
+lockPref("signon.rememberSignons", false);
 lockPref("services.sync.prefs.sync.signon.rememberSignons", false);
-
-// Pref : Disable websites autocomplete (FF30+)
-// Don't let sites dictate use of saved logins and passwords.
-lockPref("signon.storeWhenAutocompleteOff", false); // default: true
-
-// Also check policies.json for DisableMasterPasswordCreation
-
-// Pref : When password manager is enabled, lock the password storage periodically
-// CIS Version 1.2.0 October 21st, 2011 2.5.3 Disable Prompting for Credential Storage
-// Advanced user settings when password manager is enabled
+lockPref("signon.storeWhenAutocompleteOff", false);
 //lockPref("security.ask_for_password", 2);
-
-// Pref : Lock the password storage every 1 minutes (default: 30)
-// Advanced user settings when password manager is enabled
 //lockPref("security.password_lifetime", 5);
 
-// ----------------------------------------------------------------------------------------------------
+// --------------------------------
 // User Settings : History settings
-// ----------------------------------------------------------------------------------------------------
+// --------------------------------
 
-// Pref : 0804 : limit history leak via enumeration (PER TAB: back/forward) - PRIVACY
-// This is a PER TAB session history. You still have a full history stored under all history
-// default=50, minimum=1=currentpage, 2 is the recommended minimum as some pages
-// use it as a means of referral (e.g. hotlinking), 4 or 6 or 10 may be more practical
 lockPref("browser.sessionhistory.max_entries", 20);
-
-// Pref : Disable Displaying Javascript in History URLs
-// http://kb.mozillazine.org/Browser.urlbar.filter.javascript
-// CIS 2.3.6
 lockPref("browser.urlbar.filter.javascript", true);
-
-// Defaulting --------------------------
-
-// Pref: Default Interface Look
 defaultPref("browser.uiCustomization.state", '{"placements":{"widget-overflow-fixed-list":[],"nav-bar":["home-button","downloads-button","back-button","forward-button","stop-reload-button","urlbar-container","add-ons-button","preferences-button","fxa-toolbar-menu-button"],"toolbar-menubar":["menubar-items"],"TabsToolbar":["tabbrowser-tabs","new-tab-button","alltabs-button"],"PersonalToolbar":["personal-bookmarks"]},"seen":["developer-button"],"dirtyAreaCache":["nav-bar","toolbar-menubar","TabsToolbar","PersonalToolbar"],"currentVersion":16,"newElementCount":3}');
-
-// Pref : UI Density, 2=Touch
 defaultPref("browser.uidensity", 2);
-
-// Pref : Disables titlebar if enabled 
 defaultPref("browser.tabs.drawInTitlebar", true);
-
-
-
-// Pref: Default Home Page
 pref("startup.homepage_override_url", "about:blank");
 pref("startup.homepage_welcome_url", "about:blank");
 pref("startup.homepage_welcome_url.additional", "");
-
-// Pref : Clear offline site data on shutdown
 defaultPref("privacy.clearOnShutdown.offlineApps", true);
-
-// Pref : Clear offline site data on clear dialog (History/Clear...)
 defaultPref("privacy.cpd.offlineApps", true); // Offline Website Data
-
-// Pref : Set time range to "Everything" as default in "Clear Recent History"
-// This should not be enforced
 defaultPref("privacy.sanitize.timeSpan", 0);
-
-// Pref : Disable form autofill, don't save information
-// entered in web page forms and the Search Bar
-// remember search and form history setting
 defaultPref("browser.formfill.enable", false);
-
-// Pref : Defaulting Settings : Clear history when closing
 defaultPref("privacy.sanitize.sanitizeOnShutdown", true);
-
-// Pref : Defaulting Settings : Does not remember history
 defaultPref("places.history.enabled", false);
-
-// Pref : Settings history settings to custom by default
 defaultPref("privacy.history.custom", true);
-
-// -------------------------------------
-
-// Pref : Clear session data on clear dialog (History/Clear...)
 //defaultPref("privacy.cpd.openWindows", true); // Clear session data
-// Same as 2805, session storage is cleared anyway... check with storage inspector
-
-// Pref : 2805: privacy.*.openWindows (clear session restore data) (FF34+)
-// [NOTE] There is a several-year old bug associated with these that causes two windows
-// when Firefox restarts.
-// These are not needed anyway if session restore is disabled (see 1020)
 //defaultPref("privacy.clearOnShutdown.openWindows", true);
-// Breaks session restore on crash & some theming extensions
-// The session is deleted anyway on restart so its not useful
-// Mitigated with other settings
-
-// Pref : Defaulting Settings : Clear history when closing - Pref : 2803 : Duplicate ?
-// "sessions" removed from cleaning list as its an important data to keep...
-// user may add it back in the gui
-// This setting works only as string not as bool (This seems to be a bug in Firefox)
-// Also this setting seems to kill following settings so it should be the last
 //defaultPref("privacy.sanitize.pending", '[{"id":"shutdown","itemsToClear":["cache","cookies","history","formdata","downloads"],"options":{}}]');
-// Its erased if not enforced... and default does not differ a lot (session included in default...)
-// [WARNING] This erases the settings no matter what.
-
-// -------------------------------------
-
-// Pref : 1006: prevent permissions manager from writing to disk [RESTART]
-// [NOTE] This means any permission changes are session-only
-// [1] https://bugzilla.mozilla.org/967812
 //lockPref("permissions.memory_only", true); // (hidden pref)
-// This is managed by sanitize settings
-
-// Pref : Delete Search and Form History
-// Disabled - Deprecated Active - This is not deprecated
-// Only used in a single test ? does not harm to have it
-// CIS Version 1.2.0 October 21st, 2011 2.5.6
-// Default value is 180 days
-// Disabled because it's managed by sanitize settings
 //lockPref("browser.formfill.expire_days", 0);
 
-// Also check "User Settings : Session"
-
-// Also check "User Settings : Autofill settings"
+// --------------------------------------------------------------------
+// User Settings : Session : Other session settings on disabled section
+// --------------------------------------------------------------------
 
-// ----------------------------------------------------------------------------------------------------
-// User Settings : Session : Other session settings on disabled section : Also Pref : 2805
-// ----------------------------------------------------------------------------------------------------
-
-// Pref : 1021 : disable storing extra session data
-// extra session data contains contents of forms, scrollbar positions, cookies and POST data
-// set sites on which extra session data should be saved
-// Pref : 0=everywhere, 1=unencrypted sites, 2=nowhere
 lockPref("browser.sessionstore.privacy_level", 2);
-
-// Pref : 1023 : set the minimum interval between session save operations
-// Default is 15000 (15 secs). Try 30000 (30sec), 60000 (1min) etc
-// [WARNING] This can also affect entries in the "Recently Closed Tabs" feature
-// i.e. the longer the interval the more chance a quick tab open/close won't be captured.
-// This longer interval *may* affect history but we cannot replicate any history not recorded
-// [1] https://bugzilla.mozilla.org/1304389
 lockPref("browser.sessionstore.interval", 60000);
 
-// ----------------------------------------------------------------------------------------------------
+// ---------------------------------
 // User Settings : Autofill settings
-// ----------------------------------------------------------------------------------------------------
+// ---------------------------------
 
-// Pref : Forms auto fill
 lockPref("extensions.formautofill.addresses.enabled", false);
 lockPref("extensions.formautofill.available", "off");
 lockPref("extensions.formautofill.creditCards.enabled", false);
 lockPref("extensions.formautofill.heuristics.enabled", false);
 
-// Pref : Require manual intervention to autofill known username/passwords in sign-in forms
-// http://kb.mozillazine.org/Signon.autofillForms
-// https://www.torproject.org/projects/torbrowser/design/#identifier-linkability
 lockPref("signon.autofillForms", false);
-
-// Pref : When username/password autofill is enabled, still disable it on non-HTTPS sites
-// https://hg.mozilla.org/integration/mozilla-inbound/rev/f0d146fe7317
 lockPref("signon.autofillForms.http", false);
-
-// Pref : Disable inline autocomplete in URL bar
-// http://kb.mozillazine.org/Inline_autocomplete
 //lockPref("browser.urlbar.autoFill", false);
 //lockPref("browser.urlbar.autoFill.typed", false);
-// This does not cause privacy/leaking issues
 
 // ----------------------------------------------------------------------------------------------------
 // User Settings : Check default browser Settings