diff --git a/browser/components/newtab/content-src/asrouter/docs/simple-cfr-template.rst b/browser/components/newtab/content-src/asrouter/docs/simple-cfr-template.rst index d55354742099..a1edf4cc8a79 100644 --- a/browser/components/newtab/content-src/asrouter/docs/simple-cfr-template.rst +++ b/browser/components/newtab/content-src/asrouter/docs/simple-cfr-template.rst @@ -30,7 +30,7 @@ Stage 2 – Door-hanger * **title**: Title text at the top of the door hanger. * **body**: A longer paragraph of text. -* **icon**: An image (please provide a URL or the image file up to 96x96px). +* **icon**: An image (please provide a URL or the image file up to 96x96px). * **primary_button_label**: The label of the button. * **primary_button_action**: The special action triggered by clicking on the button. Choose any of the available `button actions`__. Common examples include opening a section of about:preferences, or opening a URL. diff --git a/browser/components/newtab/docs/index.rst b/browser/components/newtab/docs/index.rst index c5fa5a1b8318..cbc25504b629 100644 --- a/browser/components/newtab/docs/index.rst +++ b/browser/components/newtab/docs/index.rst @@ -96,7 +96,7 @@ running .. code-block:: shell - ./mach npm test --prefix=browser/components/newtab && + ./mach npm test --prefix=browser/components/newtab && ./mach npm run debugcoverage --prefix=browser/components/newtab Detailed Docs diff --git a/browser/components/touchbar/docs/index.rst b/browser/components/touchbar/docs/index.rst index 708eefc6ec90..ed7122f6c73d 100644 --- a/browser/components/touchbar/docs/index.rst +++ b/browser/components/touchbar/docs/index.rst @@ -361,4 +361,4 @@ Creating a Touch Bar and its ``TouchBarInputs`` flows as follows: "update" methods. This method is most often used to update ``title`` after l10n is complete. It can also be used to update any property of a ``TouchBarInput``; for instance, one might wish to change ``color`` - when a specific event occurs in the browser. \ No newline at end of file + when a specific event occurs in the browser. diff --git a/browser/components/uitour/docs/index.rst b/browser/components/uitour/docs/index.rst index 5a4dd9dcec0e..95e1fcec1a8c 100644 --- a/browser/components/uitour/docs/index.rst +++ b/browser/components/uitour/docs/index.rst @@ -6,5 +6,3 @@ UITour .. js:autoclass:: Mozilla.UITour :members: none - - diff --git a/browser/components/urlbar/docs/dynamic-result-types.rst b/browser/components/urlbar/docs/dynamic-result-types.rst index 9dea78d8eff6..62d177c7ae08 100644 --- a/browser/components/urlbar/docs/dynamic-result-types.rst +++ b/browser/components/urlbar/docs/dynamic-result-types.rst @@ -805,4 +805,3 @@ The listener should return a view update object. This step is the same as step 5 above. Bundle a CSS file in your extension and declare it in the top-level ``stylesheet`` property of your view template. - diff --git a/browser/extensions/formautofill/docs/heuristics.rst b/browser/extensions/formautofill/docs/heuristics.rst index 83dde0e2c067..cf6e49da399b 100644 --- a/browser/extensions/formautofill/docs/heuristics.rst +++ b/browser/extensions/formautofill/docs/heuristics.rst @@ -34,4 +34,3 @@ The parsers are for detecting the field type more accurately based on the near c * _parseCreditCardExpirationDateFields * related type: ``cc-exp``, ``cc-exp-month``, ``cc-exp-year`` - diff --git a/browser/installer/windows/docs/InstallerBuild.rst b/browser/installer/windows/docs/InstallerBuild.rst index 3f13b0582a03..a98e819d8c1b 100644 --- a/browser/installer/windows/docs/InstallerBuild.rst +++ b/browser/installer/windows/docs/InstallerBuild.rst @@ -53,4 +53,3 @@ Most of this procedure is done in `makensis.mk `_. - - diff --git a/build/docs/chrome-registration.rst b/build/docs/chrome-registration.rst index 4f4f8774811a..5235d80c3971 100644 --- a/build/docs/chrome-registration.rst +++ b/build/docs/chrome-registration.rst @@ -9,7 +9,7 @@ application window that are outside the window's content area. Toolbars, menu bars, progress bars, and window title bars are all examples of elements that are typically part of the chrome. -``chrome.manifest`` files are used to register XPCOM components and sources for the chrome protocol. +``chrome.manifest`` files are used to register XPCOM components and sources for the chrome protocol. Every application supplies a root ``chrome.manifest`` file that Mozilla reads on startup. Chrome providers @@ -152,7 +152,7 @@ locale A locale package is registered with the line: -.. code:: +.. code:: locale packagename localename uri/to/files/ [flags] @@ -167,7 +167,7 @@ skin A skin package is registered with the line: -.. code:: +.. code:: skin packagename skinname uri/to/files/ [flags] @@ -183,7 +183,7 @@ style Style overlays (custom CSS which will be applied to a chrome page) are registered with the following syntax: -.. code:: +.. code:: style chrome://URI-to-style chrome://stylesheet-URI [flags] @@ -195,7 +195,7 @@ file provided by the application or XULRunner. In order to allow for this, the chrome registration manifest allows for "override" instructions: -.. code:: +.. code:: override chrome://package/type/original-uri.whatever new-resolved-URI [flags] @@ -210,7 +210,7 @@ resource Aliases can be created using the ``resource`` instruction: -.. code:: +.. code:: resource aliasname uri/to/files/ [flags] @@ -237,7 +237,7 @@ Extensions may install into multiple applications. There may be chrome registration lines which only apply to one particular application. The flag -.. code:: +.. code:: application=app-ID @@ -262,7 +262,7 @@ Extensions may install into multiple versions of an application. There may be chrome registration lines which only apply to a particular application version. The flag -.. code:: +.. code:: appversion=version appversion=10.5 @@ -358,7 +358,7 @@ XPCOMABI values (concatenated with an underscore). For example: :: binary-component component/myLib.dll abi=WINNT_x86-MSVC - binary-component component/myLib.so abi=Linux_x86-gcc3 + binary-component component/myLib.so abi=Linux_x86-gcc3 platform (Platform-specific packages) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -423,39 +423,39 @@ Example chrome manifest - engine - language - url - * - content + * - content - branding - - browser/content/branding/ + - browser/content/branding/ - contentaccessible=yes - * - content - - browser + * - content + - browser - browser/content/browser/ - contentaccessible=yes - * - override - - - - chrome://global/content/license.html + * - override + - + - chrome://global/content/license.html - chrome://browser/content/license.html - * - override - - + * - override + - - chrome://global/content/netError.xhtml - chrome://browser/content/certerror/aboutNetError.xhtml - * - resource - - payments + * - resource + - payments - browser/res/payments/ - - - * - skin - - browser + - + * - skin + - browser - classic/1.0 browser/skin/classic/browser/ - - - * - locale + - + * - locale - branding - en-US - en-US/locale/branding/ - * - locale + * - locale - browser - en-US - en-US/locale/browser/ - * - locale - - browser-region + * - locale + - browser-region - en-US - - en-US/locale/browser-region/ \ No newline at end of file + - en-US/locale/browser-region/ diff --git a/build/docs/cppeclipse.rst b/build/docs/cppeclipse.rst index 1604b16ca26d..920190feb9e2 100644 --- a/build/docs/cppeclipse.rst +++ b/build/docs/cppeclipse.rst @@ -51,4 +51,3 @@ Currently, regeneration rewrites the original project files. **If you've made any customizations to the projects, they will likely get overwritten.** We would like to improve this user experience in the future. - diff --git a/build/docs/defining-xpcom-components.rst b/build/docs/defining-xpcom-components.rst index 6ec765e11d45..4eb9ef3272b4 100644 --- a/build/docs/defining-xpcom-components.rst +++ b/build/docs/defining-xpcom-components.rst @@ -29,13 +29,13 @@ The files may define any of the following special variables: # Optional: A function to be called at shutdown if any component listed in # this manifest has been instantiated. UnloadFunc = 'nsUnloadFooModule' - + # Optional: A processing priority, to determine how early or late the # manifest is processed. Defaults to 50. In practice, this mainly affects # the order in which unload functions are called at shutdown, with higher # priority numbers being called later. Priority = 10 - + # Optional: A list of header files to include before calling init or # unload functions, or any legacy constructor functions. # @@ -47,7 +47,7 @@ The files may define any of the following special variables: '/foo/nsFooModule.h', 'nsFoo.h', ] - + # A list of component classes provided by this module. Classes = [ { @@ -76,7 +76,7 @@ Class definitions may have the following properties: ``components::Foo::Create()``, respectively. ``cid`` - A UUID string containing this component's CID, in the form + A UUID string containing this component's CID, in the form ``'{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}'``. ``contract_ids`` (optional) @@ -113,7 +113,7 @@ Class definitions may have the following properties: headers listed in the ``headers`` property, must take no arguments, and must return ``already_AddRefed`` where ``iface`` is the interface provided in the ``type`` property. - + This property is incompatible with ``legacy_constructor``. ``jsm`` (optional) @@ -124,13 +124,13 @@ Class definitions may have the following properties: ``legacy_constructor`` (optional) This property is deprecated, and should not be used in new code. - + The fully-qualified name of a constructor function to call in order to create instances of this class. This function must be declared in one of the headers listed in the ``headers`` property, and must have the signature ``nsresult(nsISupports* aOuter, const nsID& aIID, void** aResult)``, and behave equivalently to ``nsIFactory::CreateInstance``. - + This property is incompatible with ``constructor``. ``singleton`` (optional, default=``False``) @@ -143,10 +143,10 @@ Class definitions may have the following properties: tests, and its ``mozilla::components::::Service()`` getter will therefore look it up by contract ID for every call. This component must, therefore, provide at least one contract ID in its ``contract_ids`` array. - + If false, the ``Service()`` getter will always retrieve the service based on its static data, and it cannot be overridden. - + Note: Enabling this option is expensive, and should not be done when it can be avoided, or when the getter is used by any hot code. @@ -155,10 +155,10 @@ Class definitions may have the following properties: another translation unit, using ``NS_IMPL_COMPONENT_FACTORY(type)``. The constructor must return an ``already_AddRefed``, and will be used to construct instances of this type. - + This option should only be used in cases where the headers which define the component's concrete type cannot be easily included without local includes. - + Note: External constructors may not specify an ``init_method``, since the generated code will not have the necessary type information required to call it. This option is also incompatible with ``constructor`` and @@ -306,4 +306,3 @@ value: 'MainProcessSingleton': ('service,@mozilla.org/main-process-singleton;1', ProcessSelector.MAIN_PROCESS_ONLY), } } - diff --git a/build/docs/mozbuild/index.rst b/build/docs/mozbuild/index.rst index 86f38940b4bd..1dbb36803454 100644 --- a/build/docs/mozbuild/index.rst +++ b/build/docs/mozbuild/index.rst @@ -38,4 +38,3 @@ to build the tree. Piecing it all together, we have frontend files that are parsed into data structures. These data structures are fed into a build backend. The output from build backends is used by builders to build the tree. - diff --git a/build/docs/rust.rst b/build/docs/rust.rst index c3d377d16070..3afd12f26cd1 100644 --- a/build/docs/rust.rst +++ b/build/docs/rust.rst @@ -122,7 +122,7 @@ Third-party crate dependencies Third-party dependencies for in-tree Rust crates are *vendored* into the ``third_party/rust`` directory of mozilla-central. This means that a copy of each third-party crate's code is committed into mozilla-central. As a result, -building Firefox does not involve downloading any third-party crates. +building Firefox does not involve downloading any third-party crates. If you add a dependency on a new crate you must run ``mach vendor rust`` to vendor the dependencies into that directory. (Note that ``mach vendor rust`` diff --git a/build/docs/supported-configurations.rst b/build/docs/supported-configurations.rst index c14015ec9bf8..de6d7154ed65 100644 --- a/build/docs/supported-configurations.rst +++ b/build/docs/supported-configurations.rst @@ -162,5 +162,3 @@ proper solution. If you can provide a patch, a regression range or assist in verifying that the developer's patches work for your platform, that would help a lot towards getting your bugs fixed and checked into the tree. - - diff --git a/build/docs/test_manifests.rst b/build/docs/test_manifests.rst index 89a7ded2aa38..60f750d6795c 100644 --- a/build/docs/test_manifests.rst +++ b/build/docs/test_manifests.rst @@ -171,7 +171,7 @@ run-sequentially scheme Changes the scheme and domain from which the test runs. (Only used in mochitest suites) - + There are two possible values: - ``http`` (default): The test will run from http://mochi.test:8888 - ``https``: The test will run from https://example.com:443 diff --git a/devtools/docs/user/3d_view/index.rst b/devtools/docs/user/3d_view/index.rst index bab91a0c1723..dfe0bb83a335 100644 --- a/devtools/docs/user/3d_view/index.rst +++ b/devtools/docs/user/3d_view/index.rst @@ -86,4 +86,3 @@ See also - :ref:`Style panel ` - :doc:`Tools <../index>` - `New Developer Tools in Firefox 11 Aurora `_ (blog post) - diff --git a/devtools/docs/user/about_colon_debugging/about_colon_debugging_before_firefox_68/index.rst b/devtools/docs/user/about_colon_debugging/about_colon_debugging_before_firefox_68/index.rst index 67401c7c9484..ad0559f61279 100644 --- a/devtools/docs/user/about_colon_debugging/about_colon_debugging_before_firefox_68/index.rst +++ b/devtools/docs/user/about_colon_debugging/about_colon_debugging_before_firefox_68/index.rst @@ -224,4 +224,3 @@ Service workers can be unavailable for several reasons: - If you are using a Private Browsing window. - If your History preference is set to "Never Remember History" or "Always use private browsing mode". - If the ``dom.serviceWorkers.enable`` preference is set to false in ``about:config``. - diff --git a/devtools/docs/user/accessibility_inspector/index.rst b/devtools/docs/user/accessibility_inspector/index.rst index 6bd3901d791c..2390e22b2951 100644 --- a/devtools/docs/user/accessibility_inspector/index.rst +++ b/devtools/docs/user/accessibility_inspector/index.rst @@ -286,4 +286,3 @@ See also - `Understanding WCAG `_ - `WAI-ARIA basics `_ - `Accessibility APIs: A Key To Web Accessibility `_ by Léonie Watson - diff --git a/devtools/docs/user/accessibility_inspector/simulation/index.rst b/devtools/docs/user/accessibility_inspector/simulation/index.rst index e73074558e5e..2265a44ebf70 100644 --- a/devtools/docs/user/accessibility_inspector/simulation/index.rst +++ b/devtools/docs/user/accessibility_inspector/simulation/index.rst @@ -87,4 +87,3 @@ See also - `Color universal design `_ - `WCAG success criterion 1.4.1: Use of color `_ - `WCAG success criterion 1.4.11: Non-text contrast `_ - diff --git a/devtools/docs/user/browser_console/index.rst b/devtools/docs/user/browser_console/index.rst index 5e81f65672a6..96f148c0b0f8 100644 --- a/devtools/docs/user/browser_console/index.rst +++ b/devtools/docs/user/browser_console/index.rst @@ -157,4 +157,3 @@ On macOS, this similar code will add a new item to the **Tools** menu: parent.appendChild(makeTheTea); .. image:: browser-console-modify-ui-osx.png - diff --git a/devtools/docs/user/browser_toolbox/index.rst b/devtools/docs/user/browser_toolbox/index.rst index 8d91da7d477f..cf3fbdefba28 100644 --- a/devtools/docs/user/browser_toolbox/index.rst +++ b/devtools/docs/user/browser_toolbox/index.rst @@ -72,4 +72,3 @@ You can use the same technique to debug `popups created by add-ons `_ - diff --git a/devtools/docs/user/debugger-api/debugger.frame/index.rst b/devtools/docs/user/debugger-api/debugger.frame/index.rst index e5e5cba8471c..b1c53f19e472 100644 --- a/devtools/docs/user/debugger-api/debugger.frame/index.rst +++ b/devtools/docs/user/debugger-api/debugger.frame/index.rst @@ -200,4 +200,3 @@ Watermark: Changeset: `e91b2c85aacd `_ - diff --git a/devtools/docs/user/debugger-api/debugger.memory/index.rst b/devtools/docs/user/debugger-api/debugger.memory/index.rst index d2bafcf73611..17f659bba8a0 100644 --- a/devtools/docs/user/debugger-api/debugger.memory/index.rst +++ b/devtools/docs/user/debugger-api/debugger.memory/index.rst @@ -238,4 +238,3 @@ Watermark: Changeset: `e91b2c85aacd `_ - diff --git a/devtools/docs/user/debugger-api/debugger.object/index.rst b/devtools/docs/user/debugger-api/debugger.object/index.rst index 8074f2b25c1e..cb553981b600 100644 --- a/devtools/docs/user/debugger-api/debugger.object/index.rst +++ b/devtools/docs/user/debugger-api/debugger.object/index.rst @@ -311,4 +311,3 @@ Watermark: sha256:7ae16a834e0883a95b4e0d227193293f6b6e4e4dd812c2570372a39c4c04897b Changeset: `5572465c08a9+ `_ - diff --git a/devtools/docs/user/debugger-api/debugger.script/index.rst b/devtools/docs/user/debugger-api/debugger.script/index.rst index 5d1b89205dc9..7df26208af90 100644 --- a/devtools/docs/user/debugger-api/debugger.script/index.rst +++ b/devtools/docs/user/debugger-api/debugger.script/index.rst @@ -270,4 +270,3 @@ Watermark: Changeset: `5572465c08a9+ `_ - diff --git a/devtools/docs/user/debugger-api/debugger.source/index.rst b/devtools/docs/user/debugger-api/debugger.source/index.rst index 8c40e66bb20e..3e4e73c1eead 100644 --- a/devtools/docs/user/debugger-api/debugger.source/index.rst +++ b/devtools/docs/user/debugger-api/debugger.source/index.rst @@ -128,4 +128,3 @@ Watermark: sha256:5ca245813db96628aab1c78b803355eb2aa8c575839c67eb7d7bde177898df88 Changeset: `e91b2c85aacd `_ - diff --git a/devtools/docs/user/debugger-api/debugger/index.rst b/devtools/docs/user/debugger-api/debugger/index.rst index 0eab535220cc..b26716a78af4 100644 --- a/devtools/docs/user/debugger-api/debugger/index.rst +++ b/devtools/docs/user/debugger-api/debugger/index.rst @@ -312,4 +312,3 @@ Watermark: Changeset: `e91b2c85aacd `_ - diff --git a/devtools/docs/user/debugger-api/tutorial-breakpoint/index.rst b/devtools/docs/user/debugger-api/tutorial-breakpoint/index.rst index f28611153738..5a23b8ae4995 100644 --- a/devtools/docs/user/debugger-api/tutorial-breakpoint/index.rst +++ b/devtools/docs/user/debugger-api/tutorial-breakpoint/index.rst @@ -106,4 +106,3 @@ Watermark: sha256:c8dd4bb69972b58e59fcbe6870499206463a5e330fda25f1214893595a1c01d0 Changeset: `ffa775dd5bd4 `_ - diff --git a/devtools/docs/user/debugger/how_to/disable_breakpoints/index.rst b/devtools/docs/user/debugger/how_to/disable_breakpoints/index.rst index 0b3e677bb38c..72a2dbd955e3 100644 --- a/devtools/docs/user/debugger/how_to/disable_breakpoints/index.rst +++ b/devtools/docs/user/debugger/how_to/disable_breakpoints/index.rst @@ -13,4 +13,3 @@ After you click the icon to disable breakpoints, the appearance of the breakpoin .. image:: disable_breakpoints.png :class: border - diff --git a/devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst b/devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst index 106b6cb06ae8..0bc2f71a9600 100644 --- a/devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst +++ b/devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst @@ -16,4 +16,3 @@ Also, when you view the details of a DOM node in the code panel, objects that yo .. image:: highlight_dom_node.png :class: border - diff --git a/devtools/docs/user/debugger/how_to/open_the_debugger/index.rst b/devtools/docs/user/debugger/how_to/open_the_debugger/index.rst index 1fecdf528159..8dfc5c013ac3 100644 --- a/devtools/docs/user/debugger/how_to/open_the_debugger/index.rst +++ b/devtools/docs/user/debugger/how_to/open_the_debugger/index.rst @@ -18,4 +18,3 @@ There are three ways to open the debugger:

- diff --git a/devtools/docs/user/debugger/how_to/pretty-print_a_minified_file/index.rst b/devtools/docs/user/debugger/how_to/pretty-print_a_minified_file/index.rst index b6e0c9c69dc7..b44ac3c48f5f 100644 --- a/devtools/docs/user/debugger/how_to/pretty-print_a_minified_file/index.rst +++ b/devtools/docs/user/debugger/how_to/pretty-print_a_minified_file/index.rst @@ -20,4 +20,3 @@ The **Pretty print source** icon is available only if the source file is minifie .. note:: Currently Firefox `does not support `_ pretty printing inline Javascript. - diff --git a/devtools/docs/user/debugger/how_to/set_a_breakpoint/index.rst b/devtools/docs/user/debugger/how_to/set_a_breakpoint/index.rst index 312f92a371e8..e92deb573d3a 100644 --- a/devtools/docs/user/debugger/how_to/set_a_breakpoint/index.rst +++ b/devtools/docs/user/debugger/how_to/set_a_breakpoint/index.rst @@ -106,4 +106,3 @@ This is a very useful timesaver when stepping through your code. Previously you .. note:: There is also a new option in the context menu for the actual code in the source pane — *Hide inline preview*/*Show inline preview* — which allows you to turn the inline variables on/off. - diff --git a/devtools/docs/user/debugger/how_to/use_a_source_map/index.rst b/devtools/docs/user/debugger/how_to/use_a_source_map/index.rst index 37ae22ab1a01..79794e580782 100644 --- a/devtools/docs/user/debugger/how_to/use_a_source_map/index.rst +++ b/devtools/docs/user/debugger/how_to/use_a_source_map/index.rst @@ -32,4 +32,3 @@ In the video above we load https://mdn.github.io/devtools-examples/sourcemaps-in //# sourceMappingURL=main.js.map In the Debugger's :ref:`source list pane `, the original CoffeeScript source now appears as "main.coffee", and we can debug it just like any other source. - diff --git a/devtools/docs/user/debugger/how_to/use_watchpoints/index.rst b/devtools/docs/user/debugger/how_to/use_watchpoints/index.rst index 1460e2ed6e0b..eb4c8038821c 100644 --- a/devtools/docs/user/debugger/how_to/use_watchpoints/index.rst +++ b/devtools/docs/user/debugger/how_to/use_watchpoints/index.rst @@ -51,4 +51,3 @@ See also ******** - `Debugging variables with watchpoints in Firefox 72 `_ - diff --git a/devtools/docs/user/devtoolsapi/index.rst b/devtools/docs/user/devtoolsapi/index.rst index 0a3cd5fe15c5..a62c072668a5 100644 --- a/devtools/docs/user/devtoolsapi/index.rst +++ b/devtools/docs/user/devtoolsapi/index.rst @@ -794,4 +794,3 @@ Add a sidebar to an existing tool: sidebar.addTab("tab1", "chrome://browser/content/.../tab1.xhtml", true); sidebar.addTab("tab2", "chrome://browser/content/.../tab2.xhtml", false); sidebar.show(); - diff --git a/devtools/docs/user/devtoolscolors/index.rst b/devtools/docs/user/devtoolscolors/index.rst index 414bfd8b6aad..68a54a1d62db 100644 --- a/devtools/docs/user/devtoolscolors/index.rst +++ b/devtools/docs/user/devtoolscolors/index.rst @@ -205,4 +205,3 @@ This chart lists colors and CSS variables as implemented in the dark theme and l .. warning:: Not yet finalized. See `bug 916766 `_ for progress. - diff --git a/devtools/docs/user/keyboard_shortcuts/index.rst b/devtools/docs/user/keyboard_shortcuts/index.rst index dc261e954195..e87e0b49f832 100644 --- a/devtools/docs/user/keyboard_shortcuts/index.rst +++ b/devtools/docs/user/keyboard_shortcuts/index.rst @@ -892,4 +892,3 @@ Keyboard shortcuts for the :doc:`Eyedropper <../eyedropper/index>`. - :kbd:`Shift` + :kbd:`arrow keys` - :kbd:`Shift` + :kbd:`arrow keys` - :kbd:`Shift` + :kbd:`arrow keys` - diff --git a/devtools/docs/user/measure_a_portion_of_the_page/index.rst b/devtools/docs/user/measure_a_portion_of_the_page/index.rst index 3c4a79cac17d..f928163b893a 100644 --- a/devtools/docs/user/measure_a_portion_of_the_page/index.rst +++ b/devtools/docs/user/measure_a_portion_of_the_page/index.rst @@ -28,4 +28,3 @@ When you stop holding the mouse down, the rectangle that was displayed on screen .. image:: resizable_measuring_area.png :class: border - diff --git a/devtools/docs/user/memory/dominators_view/index.rst b/devtools/docs/user/memory/dominators_view/index.rst index 46a6b4de28dd..a0e2c9db8770 100644 --- a/devtools/docs/user/memory/dominators_view/index.rst +++ b/devtools/docs/user/memory/dominators_view/index.rst @@ -172,5 +172,3 @@ Using the Call Stack view ************************* Finally, you can switch to the Call Stack view, see where the objects are being allocated, and jump to that point in the Debugger. - - diff --git a/devtools/docs/user/memory/index.rst b/devtools/docs/user/memory/index.rst index 465d609ec125..7a508015a1bf 100644 --- a/devtools/docs/user/memory/index.rst +++ b/devtools/docs/user/memory/index.rst @@ -50,4 +50,3 @@ Examples used in the Memory tool documentation. - :doc:`Monster example ` - :doc:`DOM allocation example ` - diff --git a/devtools/docs/user/memory/monster_example/index.rst b/devtools/docs/user/memory/monster_example/index.rst index e7ac4373d1f6..0fd6df0543d4 100644 --- a/devtools/docs/user/memory/monster_example/index.rst +++ b/devtools/docs/user/memory/monster_example/index.rst @@ -78,4 +78,3 @@ So the structure of the memory allocated on the JavaScript heap is an object con .. image:: monsters.svg :class: center - diff --git a/devtools/docs/user/page_inspector/3-pane_mode/index.rst b/devtools/docs/user/page_inspector/3-pane_mode/index.rst index 0245a0b4abb2..8cd0b094404d 100644 --- a/devtools/docs/user/page_inspector/3-pane_mode/index.rst +++ b/devtools/docs/user/page_inspector/3-pane_mode/index.rst @@ -76,4 +76,3 @@ You need to flip these two to ``true`` in Release/Beta to test the feature in Fi .. note:: The 3-pane inspector is already enabled in Nightly/Developer edition before Firefox 62. - diff --git a/devtools/docs/user/page_inspector/how_to/debug_scrollable_overflow/index.rst b/devtools/docs/user/page_inspector/how_to/debug_scrollable_overflow/index.rst index 949aa72b6cad..795e8bc3ad71 100644 --- a/devtools/docs/user/page_inspector/how_to/debug_scrollable_overflow/index.rst +++ b/devtools/docs/user/page_inspector/how_to/debug_scrollable_overflow/index.rst @@ -22,4 +22,3 @@ You will also see an ``overflow`` badge next to the node causing the overflow. .. image:: overflow_badge.png :alt: HTML Pane: Overflow badge :class: center - diff --git a/devtools/docs/user/page_inspector/how_to/edit_fonts/index.rst b/devtools/docs/user/page_inspector/how_to/edit_fonts/index.rst index 2f20d4d3ab3a..8a08ca39fbfd 100644 --- a/devtools/docs/user/page_inspector/how_to/edit_fonts/index.rst +++ b/devtools/docs/user/page_inspector/how_to/edit_fonts/index.rst @@ -255,4 +255,3 @@ Finally, here are a few tips for making effective use of the Fonts tab: :class: border - You'll also notice in the above screenshot that the font in the ``font-family`` font stack that is actually applied to the inspected element is underlined. This makes it easy to see exactly what is being applied where, when font stacks are specified. - diff --git a/devtools/docs/user/page_inspector/how_to/examine_and_edit_css/index.rst b/devtools/docs/user/page_inspector/how_to/examine_and_edit_css/index.rst index f9b371d5305b..1f0fb56c1588 100644 --- a/devtools/docs/user/page_inspector/how_to/examine_and_edit_css/index.rst +++ b/devtools/docs/user/page_inspector/how_to/examine_and_edit_css/index.rst @@ -472,4 +472,3 @@ See also - Complete list of Page Inspector :ref:`Keyboard shortcuts `. - The Inspector also includes a number of specialized tools for working with particular CSS features, such as colors, fonts, and animations. To read about these see the list of :doc:`how to guides <../../index>`. - diff --git a/devtools/docs/user/page_inspector/how_to/examine_event_listeners/index.rst b/devtools/docs/user/page_inspector/how_to/examine_event_listeners/index.rst index a95f66bae9a3..0595d6164bf8 100644 --- a/devtools/docs/user/page_inspector/how_to/examine_event_listeners/index.rst +++ b/devtools/docs/user/page_inspector/how_to/examine_event_listeners/index.rst @@ -25,5 +25,3 @@ Each line contains: - standard DOM events - `jQuery events `_ - `React events `_ - - diff --git a/devtools/docs/user/page_inspector/how_to/examine_grid_layouts/index.rst b/devtools/docs/user/page_inspector/how_to/examine_grid_layouts/index.rst index 8edf301faaa4..f8ae34c1ea96 100644 --- a/devtools/docs/user/page_inspector/how_to/examine_grid_layouts/index.rst +++ b/devtools/docs/user/page_inspector/how_to/examine_grid_layouts/index.rst @@ -187,4 +187,3 @@ See also - `labs.jensimmons.com `_ — lots of interesting grid examples. - `Grid by Example `_ — CSS Grid learning resources from Rachel Andrew. - `CSS Grid Layout `_ — MDN CSS Grid Layout references and tutorials. - diff --git a/devtools/docs/user/page_inspector/how_to/inspect_and_select_colors/index.rst b/devtools/docs/user/page_inspector/how_to/inspect_and_select_colors/index.rst index b273dc15e289..e521ef3947cd 100644 --- a/devtools/docs/user/page_inspector/how_to/inspect_and_select_colors/index.rst +++ b/devtools/docs/user/page_inspector/how_to/inspect_and_select_colors/index.rst @@ -29,4 +29,3 @@ The color picker includes an eyedropper icon: clicking this icon enables you to

- diff --git a/devtools/docs/user/page_inspector/how_to/select_and_highlight_elements/index.rst b/devtools/docs/user/page_inspector/how_to/select_and_highlight_elements/index.rst index dbcb0c918f0a..e24dd5121da5 100644 --- a/devtools/docs/user/page_inspector/how_to/select_and_highlight_elements/index.rst +++ b/devtools/docs/user/page_inspector/how_to/select_and_highlight_elements/index.rst @@ -31,5 +31,3 @@ With the node picker :width: 20 To select an element in the page itself, activate the "node picker" by clicking its icon: |image1| (also called the *Select Element* icon). After that, as you move the mouse around the page, the element under the mouse is highlighted. Click the element to select it: - - diff --git a/devtools/docs/user/page_inspector/how_to/visualize_transforms/index.rst b/devtools/docs/user/page_inspector/how_to/visualize_transforms/index.rst index ae9eb3fbdb11..46eb500581f6 100644 --- a/devtools/docs/user/page_inspector/how_to/visualize_transforms/index.rst +++ b/devtools/docs/user/page_inspector/how_to/visualize_transforms/index.rst @@ -6,4 +6,3 @@ If you hover over a `transform

- diff --git a/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__css_transitions/index.rst b/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__css_transitions/index.rst index 24d1d135002e..a4bd7bea2dcd 100644 --- a/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__css_transitions/index.rst +++ b/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__css_transitions/index.rst @@ -91,4 +91,3 @@ JavaScript Content } document.addEventListener("click", toggleSelection); - diff --git a/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__web_animations_api/index.rst b/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__web_animations_api/index.rst index 8ff1634d9245..6d6f2cb04526 100644 --- a/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__web_animations_api/index.rst +++ b/devtools/docs/user/page_inspector/how_to/work_with_animations/animation_inspector_example_colon__web_animations_api/index.rst @@ -115,4 +115,3 @@ JavaScript Content } document.addEventListener("click", animateChannel); - diff --git a/devtools/docs/user/page_inspector/how_to/work_with_animations/index.rst b/devtools/docs/user/page_inspector/how_to/work_with_animations/index.rst index 1dbfac4539bc..af69a1d066c6 100644 --- a/devtools/docs/user/page_inspector/how_to/work_with_animations/index.rst +++ b/devtools/docs/user/page_inspector/how_to/work_with_animations/index.rst @@ -225,5 +225,3 @@ The cubic Bézier editor includes a number of presets, grouped under "Ease-in",

- - diff --git a/devtools/docs/user/performance/allocations/index.rst b/devtools/docs/user/performance/allocations/index.rst index 27b8295fc52e..d1ff773dab1b 100644 --- a/devtools/docs/user/performance/allocations/index.rst +++ b/devtools/docs/user/performance/allocations/index.rst @@ -87,4 +87,3 @@ If you're seeing these problems, consider whether you can reduce the number or s - can you allocate memory lazily, when it is actually needed, instead of up front? - if allocating memory in a loop, can you reuse a single allocation in every loop iteration? - diff --git a/devtools/docs/user/performance/call_tree/index.rst b/devtools/docs/user/performance/call_tree/index.rst index 638f062dca88..01ca11f64e7f 100644 --- a/devtools/docs/user/performance/call_tree/index.rst +++ b/devtools/docs/user/performance/call_tree/index.rst @@ -128,4 +128,3 @@ To display this view, click the gear icon on the right-hand end of the performan .. image:: performance_menu_invert_call_tree.png :class: center - diff --git a/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst b/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst index 0fa7ba5fecc5..b2b7b47cad51 100644 --- a/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst +++ b/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst @@ -45,4 +45,3 @@ Note: in Windows, the ``start-debugger-server`` call will only have one dash: .. note:: By default, and for security reasons, the ``devtools.debugger.force-local`` option is set. If you want to debug a Firefox instance from an external machine, you can change this option, but only do this on a trusted network or set a strong firewall rule to lock down which machines can access it. - diff --git a/devtools/docs/user/remote_debugging/firefox_for_android/index.rst b/devtools/docs/user/remote_debugging/firefox_for_android/index.rst index 435c220ba8ac..649ff82518af 100644 --- a/devtools/docs/user/remote_debugging/firefox_for_android/index.rst +++ b/devtools/docs/user/remote_debugging/firefox_for_android/index.rst @@ -193,4 +193,3 @@ The Toolbox, and the tools it hosts, work in just the same way as they do when a .. image:: remote-debugging-debugger.png :class: center - diff --git a/devtools/docs/user/remote_debugging/index.rst b/devtools/docs/user/remote_debugging/index.rst index 5a6a106c1348..32bee4736711 100644 --- a/devtools/docs/user/remote_debugging/index.rst +++ b/devtools/docs/user/remote_debugging/index.rst @@ -12,4 +12,3 @@ You can connect the developer tools to Gecko-based runtimes like Firefox Desktop - :doc:`Firefox Desktop ` - Firefox for Android :doc:`over USB <../about_colon_debugging/index>` - :doc:`Thunderbird ` - diff --git a/devtools/docs/user/responsive_design_mode/index.rst b/devtools/docs/user/responsive_design_mode/index.rst index b8fc795006df..6eef2870c46d 100644 --- a/devtools/docs/user/responsive_design_mode/index.rst +++ b/devtools/docs/user/responsive_design_mode/index.rst @@ -206,4 +206,3 @@ To select a network, click the list box that's initially labeled "No throttling" .. image:: rdm_throttling.png :class: center - diff --git a/devtools/docs/user/settings/index.rst b/devtools/docs/user/settings/index.rst index 541f5625c073..81e68835f3b8 100644 --- a/devtools/docs/user/settings/index.rst +++ b/devtools/docs/user/settings/index.rst @@ -223,4 +223,3 @@ Advanced settings Enable a panel within the debugger to debug workers. Note: This option got removed from the UI in Firefox 56, because this version ships with a :doc:`new Debugger UI <../debugger/index>`, but it can still be enabled for the old UI by setting the preference ``devtools.debugger.workers`` to ``true``. - diff --git a/devtools/docs/user/storage_inspector/cache_storage/index.rst b/devtools/docs/user/storage_inspector/cache_storage/index.rst index 553ddd7c0a61..68dc86cd2bc1 100644 --- a/devtools/docs/user/storage_inspector/cache_storage/index.rst +++ b/devtools/docs/user/storage_inspector/cache_storage/index.rst @@ -10,4 +10,3 @@ Under the *Cache Storage* type within the :doc:`Storage Inspector <../index>` yo .. image:: cache_storage_detail.png :class: border - diff --git a/devtools/docs/user/storage_inspector/cookies/index.rst b/devtools/docs/user/storage_inspector/cookies/index.rst index a2d56a9d7d72..d6dabffd264c 100644 --- a/devtools/docs/user/storage_inspector/cookies/index.rst +++ b/devtools/docs/user/storage_inspector/cookies/index.rst @@ -40,4 +40,3 @@ The context menu for each cookie includes the following commands: .. image:: cookie_table_widget_context.png :class: border - diff --git a/devtools/docs/user/style_editor/index.rst b/devtools/docs/user/style_editor/index.rst index 041eeac9e031..fd556cf4f0fa 100644 --- a/devtools/docs/user/style_editor/index.rst +++ b/devtools/docs/user/style_editor/index.rst @@ -144,4 +144,3 @@ Keyboard shortcuts ****************** - :ref:`Source editor shortcuts ` - diff --git a/devtools/docs/user/taking_screenshots/index.rst b/devtools/docs/user/taking_screenshots/index.rst index 75852fbb4169..e989879818d4 100644 --- a/devtools/docs/user/taking_screenshots/index.rst +++ b/devtools/docs/user/taking_screenshots/index.rst @@ -125,4 +125,3 @@ The command has the following optional parameters: .. note:: Thanks to Eric Meyer for his enthusiasm for our screenshot feature, and help! Small portions of this section have been borrowed from his `Firefox’s :screenshot command `_ article. - diff --git a/devtools/docs/user/tips/index.rst b/devtools/docs/user/tips/index.rst index d4658979352c..156919c8be94 100644 --- a/devtools/docs/user/tips/index.rst +++ b/devtools/docs/user/tips/index.rst @@ -142,4 +142,3 @@ Storage Inspector - Right-click the column headers to open a menu allowing to toggle the display of the columns. - Right-click an entry and click "Delete *name*" to delete it or "Delete All" to delete all entries. - Select an entry to see the parsed value of it in the sidebar. - diff --git a/devtools/docs/user/validators/index.rst b/devtools/docs/user/validators/index.rst index 1fe034833249..65abf1c4f26b 100644 --- a/devtools/docs/user/validators/index.rst +++ b/devtools/docs/user/validators/index.rst @@ -9,5 +9,3 @@ This article lists different resources for developers to check web documents. - `W3C CSS Validator `_ validates CSS stylesheets. - `W3C Link Checker `_ checks for broken links in HTML documents. - `HTML Tidy `_ tool finds errors in HTML documents, and can automatically fix some errors. - - diff --git a/devtools/docs/user/view_source/index.rst b/devtools/docs/user/view_source/index.rst index b542b30b43a6..12f7983dc843 100644 --- a/devtools/docs/user/view_source/index.rst +++ b/devtools/docs/user/view_source/index.rst @@ -88,4 +88,3 @@ See also ******** - `HTML5 Parser-Based View Source Syntax Highlighting `_ (Blog post) - diff --git a/devtools/docs/user/web_console/helpers/index.rst b/devtools/docs/user/web_console/helpers/index.rst index 93087241943c..9a1013dc3e31 100644 --- a/devtools/docs/user/web_console/helpers/index.rst +++ b/devtools/docs/user/web_console/helpers/index.rst @@ -138,4 +138,3 @@ See also ******** - `console `_ - diff --git a/devtools/docs/user/web_console/split_console/index.rst b/devtools/docs/user/web_console/split_console/index.rst index c3109de88cd0..13bee8efc738 100644 --- a/devtools/docs/user/web_console/split_console/index.rst +++ b/devtools/docs/user/web_console/split_console/index.rst @@ -24,4 +24,3 @@ When you use the split console with the debugger, the console's scope is the cur .. image:: split-console-show-debug.png :class: center - diff --git a/devtools/docs/user/working_with_iframes/index.rst b/devtools/docs/user/working_with_iframes/index.rst index b9fef65c08d6..8d75d97a6430 100644 --- a/devtools/docs/user/working_with_iframes/index.rst +++ b/devtools/docs/user/working_with_iframes/index.rst @@ -23,4 +23,3 @@ To set an iframe as the target for the developer tools: .. note:: The iframe context picker button feature is enabled by default (if it has been disabled the iframe button is never displayed). The feature can be re-enabled from the Settings menu, using the "Select an iframe as the currently targeted document" checkbox. - diff --git a/docs/bug-mgmt/policies/triage-bugzilla.rst b/docs/bug-mgmt/policies/triage-bugzilla.rst index 498e9955a8e1..d9e9f2d9bb0f 100644 --- a/docs/bug-mgmt/policies/triage-bugzilla.rst +++ b/docs/bug-mgmt/policies/triage-bugzilla.rst @@ -37,7 +37,7 @@ Staying on top of the bugs in your component means: - Members of your team do not see the bug queue and get the ‘wiggins’ - + Who Triages ----------- diff --git a/docs/bug-mgmt/processes/fixing-security-bugs.rst b/docs/bug-mgmt/processes/fixing-security-bugs.rst index 37b7f606f5c8..fe460cc8334a 100644 --- a/docs/bug-mgmt/processes/fixing-security-bugs.rst +++ b/docs/bug-mgmt/processes/fixing-security-bugs.rst @@ -71,7 +71,7 @@ In addition to commits, you’ll need to be mindful of not disclosing sensitive information about the bug in public places, such as Bugzilla: - **Do not add public bugs in the “duplicate”, “depends on”, “blocks”, - “regression”, “regressed by”, or “see also” section if these bugs + “regression”, “regressed by”, or “see also” section if these bugs could give hints about the nature of the security issue.** - Mention the bugs in comment of the private bug instead. diff --git a/docs/bug-mgmt/processes/security-approval.rst b/docs/bug-mgmt/processes/security-approval.rst index e46ebd43cc8f..f8d2b7de4db1 100644 --- a/docs/bug-mgmt/processes/security-approval.rst +++ b/docs/bug-mgmt/processes/security-approval.rst @@ -104,7 +104,7 @@ explicit approval if: If it meets the above criteria, developers do not need to ask for sec-approval. -In all other cases, developers should ask for sec-approval. +In all other cases, developers should ask for sec-approval. Set the sec-approval flag to '?' on the patch when it is ready to be landed. You will find these flags in Bugzilla using the "Details" links in the Bugzilla attachment table (not directly on phabricator at time of writing). @@ -193,4 +193,3 @@ multiple axes: The most common choice is: not much stability risk, not an immediate reverse engineering risk, moderate to high difficulty of exploitation: "land whenever". - diff --git a/docs/code-quality/coding-style/coding_style_js.rst b/docs/code-quality/coding-style/coding_style_js.rst index 46ec1dd8a6aa..9b097a117c6b 100644 --- a/docs/code-quality/coding-style/coding_style_js.rst +++ b/docs/code-quality/coding-style/coding_style_js.rst @@ -147,4 +147,3 @@ Other advices extract substrings in known positions in the string. For instance, {{JSxRef("String.slice", "aString.slice(-1)")}} returns the last letter in ``aString``, or the empty string if ``aString`` is empty. - diff --git a/docs/code-quality/coding-style/coding_style_other.rst b/docs/code-quality/coding-style/coding_style_other.rst index 2c82cc4a765c..569b874d8733 100644 --- a/docs/code-quality/coding-style/coding_style_other.rst +++ b/docs/code-quality/coding-style/coding_style_other.rst @@ -8,4 +8,3 @@ SVG practices Check `SVG Guidelines `__ for more details. - diff --git a/docs/code-quality/coding-style/using_cxx_in_firefox_code.rst b/docs/code-quality/coding-style/using_cxx_in_firefox_code.rst index bbeb96dc9d8e..e324501dcefd 100644 --- a/docs/code-quality/coding-style/using_cxx_in_firefox_code.rst +++ b/docs/code-quality/coding-style/using_cxx_in_firefox_code.rst @@ -38,7 +38,7 @@ list of acceptable features is given below: :widths: 25 25 25 25 :header-rows: 3 - * - + * - - GCC - Clang - @@ -606,11 +606,11 @@ Miscellaneous - xpcom/ds/TimeStamp.h - ``std::chrono::time_point`` - - * - + * - - mozilla/TypeTraits.h - ```` - - * - + * - - mozilla/PodOperations.h - - C++ versions of ``memset``, ``memcpy``, etc. @@ -622,7 +622,7 @@ Miscellaneous - mozilla/Compression.h - - - * - + * - - mozilla/Endian.h - - @@ -630,11 +630,11 @@ Miscellaneous - mozilla/FloatingPoint.h - - - * - + * - - mozilla/HashFunctions.h - ``std::hash`` - - * - + * - - mozilla/Move.h - ``std::move``, ``std::swap``, ``std::forward`` - diff --git a/docs/code-quality/lint/linters/cpp-virtual-final.rst b/docs/code-quality/lint/linters/cpp-virtual-final.rst index 5353b6b4fe03..0424877ea0c9 100644 --- a/docs/code-quality/lint/linters/cpp-virtual-final.rst +++ b/docs/code-quality/lint/linters/cpp-virtual-final.rst @@ -27,4 +27,3 @@ Sources ------- * `Configuration (YAML) `_ - diff --git a/docs/code-quality/static-analysis/index.rst b/docs/code-quality/static-analysis/index.rst index b0800e2a8199..144ef7e9096f 100755 --- a/docs/code-quality/static-analysis/index.rst +++ b/docs/code-quality/static-analysis/index.rst @@ -20,7 +20,7 @@ integrating this process with Phabricator and mach. A list of some checkers that are used during automated scan can be found `here `__. -This documentation is split into two parts: +This documentation is split into two parts: .. toctree:: :maxdepth: 1 diff --git a/docs/code-quality/static-analysis/writing-new/adding-a-check.rst b/docs/code-quality/static-analysis/writing-new/adding-a-check.rst index 9ef336a67aab..842d2bed1913 100644 --- a/docs/code-quality/static-analysis/writing-new/adding-a-check.rst +++ b/docs/code-quality/static-analysis/writing-new/adding-a-check.rst @@ -22,16 +22,16 @@ First pick a name. Pick something that makes sense without punctuation, in no mo /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ - + #include "MissingElseInEnumComparisons.h" #include "CustomMatchers.h" - + void MissingElseInEnumComparisons::registerMatchers(MatchFinder *AstMatcher) { - + } - + void MissingElseInEnumComparisons::check(const MatchFinder::MatchResult &Result) { - + } @@ -104,4 +104,4 @@ You'll need to edit two things: Running it on Central ---------------------- -After this, the next thing to do is to add ``ac_add_options --enable-clang-plugin`` to your .mozconfig and do a build. Your plugin will be automatically compiled and used across the entire codebase. I suggest using ``./mach build | tee output.txt`` and then ``grep "Enum comparisons" output.txt | cut -d " " -f 3- | sort | uniq``. (The ``cut`` is there to get rid of the timestamp in the line.) \ No newline at end of file +After this, the next thing to do is to add ``ac_add_options --enable-clang-plugin`` to your .mozconfig and do a build. Your plugin will be automatically compiled and used across the entire codebase. I suggest using ``./mach build | tee output.txt`` and then ``grep "Enum comparisons" output.txt | cut -d " " -f 3- | sort | uniq``. (The ``cut`` is there to get rid of the timestamp in the line.) diff --git a/docs/code-quality/static-analysis/writing-new/advanced-check-features.rst b/docs/code-quality/static-analysis/writing-new/advanced-check-features.rst index bcbe18d8b9b9..e8adcf664ffb 100644 --- a/docs/code-quality/static-analysis/writing-new/advanced-check-features.rst +++ b/docs/code-quality/static-analysis/writing-new/advanced-check-features.rst @@ -87,7 +87,7 @@ And in our check() function, we can use it like so: const MatchFinder::MatchResult &Result) { const auto *MatchedDecl = Result.Nodes.getNodeAs("node"); const auto *EnumType = Result.Nodes.getNodeAs("enumType"); - + diag(MatchedDecl->getIfLoc(), "Enum comparisons to %0 in an if/else if block without a trailing else.", DiagnosticIDs::Warning) << EnumType->getName(); @@ -145,4 +145,4 @@ While it's not a great situation, you can set up an allow-list of existing calls Custom Annotations ------------------ -It's possible to create custom annotations that will be a no-op when compiled, but can be used by a static analysis check. These can be used to annotate special types of sources and sinks (for example). We have some examples of this in-tree presently (such as ``MOZ_CAN_RUN_SCRIPT``) but currently don't have a detailed walkthrough in this documentation of how to set these up and use them. (Patches welcome.) \ No newline at end of file +It's possible to create custom annotations that will be a no-op when compiled, but can be used by a static analysis check. These can be used to annotate special types of sources and sinks (for example). We have some examples of this in-tree presently (such as ``MOZ_CAN_RUN_SCRIPT``) but currently don't have a detailed walkthrough in this documentation of how to set these up and use them. (Patches welcome.) diff --git a/docs/code-quality/static-analysis/writing-new/clang-query.rst b/docs/code-quality/static-analysis/writing-new/clang-query.rst index b9d6ac352320..1308a3282191 100755 --- a/docs/code-quality/static-analysis/writing-new/clang-query.rst +++ b/docs/code-quality/static-analysis/writing-new/clang-query.rst @@ -37,20 +37,20 @@ More examples are available `in the documentation match functionDecl().bind("x") - - Match #1: - - testfile.cpp:1:1: note: "root" binds here - int addTwo(int num) - ^~~~~~~~~~~~~~~~~~~ - testfile.cpp:1:1: note: "x" binds here - int addTwo(int num) - ^~~~~~~~~~~~~~~~~~~ - - Match #2: - - testfile.cpp:6:1: note: "root" binds here - int main(int, char**) - ^~~~~~~~~~~~~~~~~~~~~ - testfile.cpp:6:1: note: "x" binds here - int main(int, char**) - ^~~~~~~~~~~~~~~~~~~~~ - 2 matches. + clang-query> match functionDecl().bind("x") + + Match #1: + + testfile.cpp:1:1: note: "root" binds here + int addTwo(int num) + ^~~~~~~~~~~~~~~~~~~ + testfile.cpp:1:1: note: "x" binds here + int addTwo(int num) + ^~~~~~~~~~~~~~~~~~~ + + Match #2: + + testfile.cpp:6:1: note: "root" binds here + int main(int, char**) + ^~~~~~~~~~~~~~~~~~~~~ + testfile.cpp:6:1: note: "x" binds here + int main(int, char**) + ^~~~~~~~~~~~~~~~~~~~~ + 2 matches. clang-query automatically binds ``root`` to the match, but we also bound the name ``x`` to that match. The ``root`` is redundant. If you ``set bind-root false`` then the output is less noisy: :: - clang-query> set bind-root false - clang-query> m functionDecl().bind("x") - - Match #1: - + clang-query> set bind-root false + clang-query> m functionDecl().bind("x") + + Match #1: + testfile.cpp:1:1: note: "x" binds here - int addtwo(int num) - ^~~~~~~~~~~~~~~~~~~ - - Match #2: - - testfile.cpp:6:1: note: "x" binds here - int main(int, char**) - ^~~~~~~~~~~~~~~~~~~~~ - 2 matches. + int addtwo(int num) + ^~~~~~~~~~~~~~~~~~~ + + Match #2: + + testfile.cpp:6:1: note: "x" binds here + int main(int, char**) + ^~~~~~~~~~~~~~~~~~~~~ + 2 matches. set print-matcher @@ -126,7 +126,7 @@ These commands will control the type of output you get from clang-query. The opt Shows you the C++ form of the node you are matching. This is typically not useful. ``diag`` - Shows you the individual node you are matching. + Shows you the individual node you are matching. ``dump`` (alias: ``detailed-ast``) Shows you the node you are matching and the entire subtree for the node @@ -165,4 +165,3 @@ This section tracks some patches; they are currently not used, but we may want t - `mapAnyOf() `_ (`Example of usage `_) - `Make cxxOperatorCallExpr matchers API-compatible with n-ary operators `_ - `CXXRewrittenBinaryOperator `_ - diff --git a/docs/code-quality/static-analysis/writing-new/compiler-explorer.rst b/docs/code-quality/static-analysis/writing-new/compiler-explorer.rst index 30361e0405f1..ff0b0101ac8a 100755 --- a/docs/code-quality/static-analysis/writing-new/compiler-explorer.rst +++ b/docs/code-quality/static-analysis/writing-new/compiler-explorer.rst @@ -54,7 +54,7 @@ Under the 'Library' toolbar button for the compiler, you will see that the Mozil #. Generated headers (which come from the obj-dir) are generated on a Linux x64 machine. #. The default mozilla-config.h comes from the objdir as well, as therefore will specify things such as `MOZ_WEBRTC=1` -#. Non-generated headers will be extracted from moz.build files in an `imperfect way `_ that tries to exclude Windows/OSX/Android headers. But this script may have bugs in it. If you encounter one, `feel free to file an issue `_. +#. Non-generated headers will be extracted from moz.build files in an `imperfect way `_ that tries to exclude Windows/OSX/Android headers. But this script may have bugs in it. If you encounter one, `feel free to file an issue `_. #. Sometimes gecko code will get some `additional, non-global include directories `_ that are not available. These can be added by including a compile flag like ``-I/mozilla-central/accessible/base``. #. We update mozilla-central and refresh the headers every hour, so they may not match your exact expected version. diff --git a/docs/code-quality/static-analysis/writing-new/index.rst b/docs/code-quality/static-analysis/writing-new/index.rst index 2964915d1d8d..95cf7d637843 100755 --- a/docs/code-quality/static-analysis/writing-new/index.rst +++ b/docs/code-quality/static-analysis/writing-new/index.rst @@ -13,4 +13,3 @@ or seriously develop one we can land and run internally. While being written fo matcher-cookbook.rst adding-a-check.rst advanced-check-features.rst - diff --git a/docs/code-quality/static-analysis/writing-new/matcher-cookbook.rst b/docs/code-quality/static-analysis/writing-new/matcher-cookbook.rst index 07cc94721745..9eb0d96c4315 100644 --- a/docs/code-quality/static-analysis/writing-new/matcher-cookbook.rst +++ b/docs/code-quality/static-analysis/writing-new/matcher-cookbook.rst @@ -5,14 +5,14 @@ Matcher Cookbook This page is designed to be a selection of common ingredients to a more complicated matcher. -.. list-table:: +.. list-table:: :widths: 35 65 :header-rows: 1 :class: matcher-cookbook * - Desired Outcome - Syntax - * - Ignore header files + * - Ignore header files *If you have an #include in your example code, your matcher may match things in the header files.* - Add **isExpansionInMainFile()** to the matcher. e.g. @@ -20,4 +20,4 @@ This page is designed to be a selection of common ingredients to a more complica ``m functionDecl(isExpansionInMainFile())`` -*More coming* \ No newline at end of file +*More coming* diff --git a/docs/code-quality/static-analysis/writing-new/writing-matchers.rst b/docs/code-quality/static-analysis/writing-new/writing-matchers.rst index 8ee9d6700491..5b693f5f27a1 100755 --- a/docs/code-quality/static-analysis/writing-new/writing-matchers.rst +++ b/docs/code-quality/static-analysis/writing-new/writing-matchers.rst @@ -47,7 +47,7 @@ If you *need* to specify a narrowing matcher (because it's a required argument t Traversal Matchers ~~~~~~~~~~~~~~~~~~ -Traversal Matchers *also* can be thought of as adjectives - at least most of them. They also describe a specific node, but the difference from a narrowing matcher is that the scope of the description is broader than the individual node. A narrowing matcher says something about the node in isolation (e.g. the number of arguments it has) while a traversal matcher says something about the node's contents or place in the program. +Traversal Matchers *also* can be thought of as adjectives - at least most of them. They also describe a specific node, but the difference from a narrowing matcher is that the scope of the description is broader than the individual node. A narrowing matcher says something about the node in isolation (e.g. the number of arguments it has) while a traversal matcher says something about the node's contents or place in the program. Again, the `the documentation `_ is the best place to explore and understand these, but here is a simple example for the traversal matcher ``hasArraySize()``: @@ -56,14 +56,14 @@ Again, the `the documentation `__. Questions are best raised in `#build `__ on `Matrix `__. Please file bugs in *Firefox Build System :: General*, blocking `Bug 901840 `__ - diff --git a/docs/contributing/build/supported.rst b/docs/contributing/build/supported.rst index 4ebe69ced50c..4223f812ff1b 100644 --- a/docs/contributing/build/supported.rst +++ b/docs/contributing/build/supported.rst @@ -1 +1 @@ -.. include:: ../../build/buildsystem/supported-configurations.rst +.. include:: ../../build/buildsystem/supported-configurations.rst diff --git a/docs/contributing/committing_rules_and_responsibilities.rst b/docs/contributing/committing_rules_and_responsibilities.rst index e12fa1eb2af7..c3edcba79fb7 100644 --- a/docs/contributing/committing_rules_and_responsibilities.rst +++ b/docs/contributing/committing_rules_and_responsibilities.rst @@ -144,7 +144,7 @@ Dealing with test failures ~~~~~~~~~~~~~~~~~~~~~~~~~~ If a build or a test job fails, you can click on the red or orange or -purple symbol for the job on Treeherder to display more information. +purple symbol for the job on Treeherder to display more information. The information will appear in the footer, including a summary of any error messages, a "+" icon to re-trigger the job (schedule it to run again), and links to the log files and to possibly-related bugs. diff --git a/docs/contributing/debugging/capturing_minidump.rst b/docs/contributing/debugging/capturing_minidump.rst index 78db07b5778e..4c8f7591f535 100644 --- a/docs/contributing/debugging/capturing_minidump.rst +++ b/docs/contributing/debugging/capturing_minidump.rst @@ -74,7 +74,7 @@ Capture a minidump in a graphical way |WinDbg in Start Menu| -#. Connect Firefox to the debugger. +#. Connect Firefox to the debugger. a. If Firefox is not already running, open the **"File"** menu on WinDbg and choose **"Open Executable..."**. In the file chooser window that @@ -257,4 +257,3 @@ of "Application Binary". .. |WinDbg in Start Menu| image:: img/windbg-in-startmenu.png :width: 50% - diff --git a/docs/contributing/debugging/debugging_firefox_with_gdb.rst b/docs/contributing/debugging/debugging_firefox_with_gdb.rst index 992bce3e9e4c..8b188edc859d 100644 --- a/docs/contributing/debugging/debugging_firefox_with_gdb.rst +++ b/docs/contributing/debugging/debugging_firefox_with_gdb.rst @@ -84,7 +84,7 @@ you have to set a breakpoint you can set a breakpoint in ``_dl_open``. This function is called when a new library is loaded, when you can finally set your breakpoint. -How do I set a breakpoint when a component is loaded? +How do I set a breakpoint when a component is loaded? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In Firefox Version 57 (and possibly earlier) XPCOM_BREAK_ON_LOAD does @@ -144,7 +144,7 @@ One suggestion is this: $47 = {114, 100, 102, 58, 110, 117, 108, 108, 0, 0, 8, 0, 0, 0, 37432, 16514} - + .. code:: @@ -284,7 +284,7 @@ JS stack in addition to the C++ stack. .. code:: - (gdb) call DumpJSStack() + (gdb) call DumpJSStack() See `https://developer.mozilla.org/en-US/docs/Mozilla/Debugging/Debugging_JavaScript `__ for more JS debugging tricks. @@ -499,5 +499,3 @@ See also - Copyright Information: © 1998-2008 by individual mozilla.org contributors; content available under a `Creative Commons license `__ - - diff --git a/docs/contributing/debugging/debugging_on_windows.rst b/docs/contributing/debugging/debugging_on_windows.rst index 52aae7773f2d..4e4d9b633c72 100644 --- a/docs/contributing/debugging/debugging_on_windows.rst +++ b/docs/contributing/debugging/debugging_on_windows.rst @@ -409,7 +409,7 @@ There are two ways to work around this problem: symchk.exe /r C:\windows\SysWOW64\ /s "SRV*\MicrosoftPublicSymbols*http://msdl.microsoft.com/download/symbols" - | + | | Note the "``\MicrosoftPublicSymbols``" appended to the cache directory configured in Visual Studio. @@ -429,7 +429,7 @@ debugging the program crashes with an Access Violation, you may be hitting a Windows bug relating to AVX support. For more details, including a work-around see `this blog post `__ or `this social.msdn -thread `__. +thread `__. (And just in-case those links die, the work-around is to execute :: diff --git a/docs/contributing/how_to_submit_a_patch.rst b/docs/contributing/how_to_submit_a_patch.rst index 63b41ddfbc3b..5b060d4a9fdc 100644 --- a/docs/contributing/how_to_submit_a_patch.rst +++ b/docs/contributing/how_to_submit_a_patch.rst @@ -105,7 +105,7 @@ simple commit message should look like this: Bug 123456 - Change this thing to work better by doing something. r=reviewers -The ``r=reviewers`` part is optional; if you are using Phabricator, +The ``r=reviewers`` part is optional; if you are using Phabricator, Lando will add it automatically based on who actually granted review, and in any case the person who does the final check-in of the patch will make sure it's added. @@ -113,7 +113,7 @@ make sure it's added. The text of the message should be what you did to fix the bug, not a description of what the bug was. If it is not obvious why this change is appropriate, then `explain why in the commit -message `__. +message `__. If this does not fit on one line, then leave a blank line and add further lines for more detail and/or reasoning. diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 9a042bc86269..6bde903f4e0e 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -32,7 +32,7 @@ development process and source code documentation. .. toctree:: :caption: Additional Information :maxdepth: 1 - + directory_structure build/artifact_builds build/building_mobile_firefox diff --git a/docs/contributing/pocket-guide-shipping-firefox.rst b/docs/contributing/pocket-guide-shipping-firefox.rst index 4ff84927e33f..ffa120844063 100644 --- a/docs/contributing/pocket-guide-shipping-firefox.rst +++ b/docs/contributing/pocket-guide-shipping-firefox.rst @@ -152,7 +152,7 @@ Merge Day Nightly W1 Monday Day 1 of th `PI Request ` deadline Nightly W1 Friday Manual QA request deadline for high risk features Feature technical documentation due Nightly W2 Friday Deadline for features requiring manual QA Beta release notes draft Nightly W4 Wednesday -Nightly features Go/No-Go decisions Nightly W4 Wednesday +Nightly features Go/No-Go decisions Nightly W4 Wednesday Feature Complete Milestone Nightly W4 Wednesday Last day to land risky patches and/or enable new features Nightly soft code freeze start Nightly W4 Thursday Stabilization period in preparation to merge to Beta String freeze Nightly W4 Thursday Modification or deletion of strings exposed to the end-users is not allowed @@ -430,5 +430,3 @@ number of different "trains" on a regular schedule. **Uplift** - the action of taking parts from a newer version of a software system (mozilla-central or mozilla-beta) and porting them to an older version of the same software (mozilla-beta or mozilla-release) - - diff --git a/docs/contributing/vcs/mercurial.rst b/docs/contributing/vcs/mercurial.rst index a3250e92b1e3..79e1e56d1e66 100644 --- a/docs/contributing/vcs/mercurial.rst +++ b/docs/contributing/vcs/mercurial.rst @@ -29,7 +29,7 @@ Using Mercurial bundles If you are worried that your Internet connection is not fast or robust enough to download such a large amount of data all in one go without -being interrupted and cannot clone using the command given above, then you are recommended to try :ref:`Mercurial bundles `. If interrupted, they can be resumed (continued without downloading +being interrupted and cannot clone using the command given above, then you are recommended to try :ref:`Mercurial bundles `. If interrupted, they can be resumed (continued without downloading from the beginning) if the app you're using to download supports it. For example, in Firefox you would right click on the download and select `Resume` once your connection to the Internet was reestablished. diff --git a/docs/index.rst b/docs/index.rst index 76f3f4e0f6af..fb18991d2bac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,7 +45,7 @@ Firefox Source Tree Documentation {l10n_doc} .. toctree:: - :caption: Firefox and Python + :caption: Firefox and Python :maxdepth: 1 {python_doc} diff --git a/docs/nspr/nonblocking_io_in_nspr.rst b/docs/nspr/nonblocking_io_in_nspr.rst index 2875006fbdf2..a5ba816412a2 100644 --- a/docs/nspr/nonblocking_io_in_nspr.rst +++ b/docs/nspr/nonblocking_io_in_nspr.rst @@ -40,7 +40,7 @@ In NSPR, a new socket returned by PR_NewTCPSocket() or make the new socket nonblocking by using PR_SetSockOpt() as in the example below (error checking is omitted for clarity): -| +| | PRFileDesc \*sock; | **PRIntn optval = 1;** diff --git a/docs/nspr/reference/nspr_log_file.rst b/docs/nspr/reference/nspr_log_file.rst index 1df56fcdee78..0208d4bac4cf 100644 --- a/docs/nspr/reference/nspr_log_file.rst +++ b/docs/nspr/reference/nspr_log_file.rst @@ -12,7 +12,7 @@ Syntax filespec -*filespec* is a filename. The exact syntax is platform specific. +*filespec* is a filename. The exact syntax is platform specific. Description diff --git a/docs/nspr/reference/nspr_log_modules.rst b/docs/nspr/reference/nspr_log_modules.rst index 98d783f7aa6c..9f2986607f62 100644 --- a/docs/nspr/reference/nspr_log_modules.rst +++ b/docs/nspr/reference/nspr_log_modules.rst @@ -34,12 +34,12 @@ Specify a ``moduleName`` that is associated with the ``name`` argument in a call to `:ref:`PR_NewLogModule` `__ and a non-zero ``level`` value to enable logging for the named -``moduleName``. +``moduleName``. Special log module names are provided for controlling NSPR's log service at execution time. These controls should be set in the :ref:`NSPR_LOG_MODULES` environment variable at execution time to affect -NSPR's log service for your application. +NSPR's log service for your application. - **all** The name ``all`` enables all log modules. To enable all log module calls to diff --git a/docs/nspr/reference/pr_atomicadd.rst b/docs/nspr/reference/pr_atomicadd.rst index 7314dfb17c70..636dfbdf887c 100644 --- a/docs/nspr/reference/pr_atomicadd.rst +++ b/docs/nspr/reference/pr_atomicadd.rst @@ -35,5 +35,3 @@ Description ----------- Atomically add a 32 bit value. - - diff --git a/docs/nspr/reference/pr_connectcontinue.rst b/docs/nspr/reference/pr_connectcontinue.rst index cc0ddc0ca5c8..7ad5df60dc66 100644 --- a/docs/nspr/reference/pr_connectcontinue.rst +++ b/docs/nspr/reference/pr_connectcontinue.rst @@ -51,5 +51,3 @@ PR_POLL_EXCEPT. When PR_Poll() returns, one calls PR_ConnectContinue() on the socket to determine whether the nonblocking connect has completed or is still in progress. Repeat the PR_Poll(), PR_ConnectContinue() sequence until the nonblocking connect has completed. - - diff --git a/docs/nspr/reference/pr_delete.rst b/docs/nspr/reference/pr_delete.rst index e65851552c65..183b068819bf 100644 --- a/docs/nspr/reference/pr_delete.rst +++ b/docs/nspr/reference/pr_delete.rst @@ -36,5 +36,3 @@ Description :ref:`PR_Delete` deletes a file with the specified pathname ``name``. If the function fails, the error code can then be retrieved via :ref:`PR_GetError`. - - diff --git a/docs/nspr/reference/pr_intervalnow.rst b/docs/nspr/reference/pr_intervalnow.rst index acfa2d1e1170..8d9ef69e436a 100644 --- a/docs/nspr/reference/pr_intervalnow.rst +++ b/docs/nspr/reference/pr_intervalnow.rst @@ -48,5 +48,3 @@ call ``PR_IntervalNow()`` in a sequence that looks like this: if (PR_FAILURE == rv) break; /* likely an interrupt */ } PR_Unlock(data->mutex); - - diff --git a/docs/nspr/reference/pr_open.rst b/docs/nspr/reference/pr_open.rst index 18a2c330df89..c6f18dcbdd71 100644 --- a/docs/nspr/reference/pr_open.rst +++ b/docs/nspr/reference/pr_open.rst @@ -68,7 +68,7 @@ The function has the following parameters: | | | and NULL is returned. | +--------------------+-------+---------------------------------------+ - + ``mode`` When ``PR_CREATE_FILE`` flag is set and the file is created, these diff --git a/docs/nspr/reference/prfileinfo.rst b/docs/nspr/reference/prfileinfo.rst index 53d27755d242..51591eb4e1f5 100644 --- a/docs/nspr/reference/prfileinfo.rst +++ b/docs/nspr/reference/prfileinfo.rst @@ -21,7 +21,7 @@ Syntax typedef struct PRFileInfo PRFileInfo; - + Fields diff --git a/docs/nspr/reference/prlogmoduleinfo.rst b/docs/nspr/reference/prlogmoduleinfo.rst index d0fe3314116c..ea616e435a36 100644 --- a/docs/nspr/reference/prlogmoduleinfo.rst +++ b/docs/nspr/reference/prlogmoduleinfo.rst @@ -6,7 +6,7 @@ The ``PRLogModuleInfo`` structure controls logging from within your application. To log your program's activity, create a ``PRLogModuleInfo`` structure using `:ref:`PR_NewLogModule` `__ -. +. Syntax diff --git a/docs/nspr/reference/process_management_and_interprocess_communication.rst b/docs/nspr/reference/process_management_and_interprocess_communication.rst index 8b00ee78e056..c508c7362c9b 100644 --- a/docs/nspr/reference/process_management_and_interprocess_communication.rst +++ b/docs/nspr/reference/process_management_and_interprocess_communication.rst @@ -21,7 +21,7 @@ Process Management Types and Constants The types defined for process management are: - - :ref:`PRProcess` + - :ref:`PRProcess` - :ref:`PRProcessAttr` .. _Process_Management_Functions: @@ -44,11 +44,11 @@ Setting the Attributes of a New Process The functions that create and manipulate attribute sets of new processes are: - - :ref:`PR_NewProcessAttr` - - :ref:`PR_ResetProcessAttr` - - :ref:`PR_DestroyProcessAttr` - - :ref:`PR_ProcessAttrSetStdioRedirect` - - :ref:`PR_ProcessAttrSetCurrentDirectory` + - :ref:`PR_NewProcessAttr` + - :ref:`PR_ResetProcessAttr` + - :ref:`PR_DestroyProcessAttr` + - :ref:`PR_ProcessAttrSetStdioRedirect` + - :ref:`PR_ProcessAttrSetCurrentDirectory` - :ref:`PR_ProcessAttrSetInheritableFD` .. _Creating_and_Managing_Processes: @@ -58,7 +58,7 @@ Creating and Managing Processes The functions that create and manage processes are: - - :ref:`PR_CreateProcess` - - :ref:`PR_DetachProcess` - - :ref:`PR_WaitProcess` + - :ref:`PR_CreateProcess` + - :ref:`PR_DetachProcess` + - :ref:`PR_WaitProcess` - :ref:`PR_KillProcess` diff --git a/docs/nspr/reference/prthreadstack.rst b/docs/nspr/reference/prthreadstack.rst index e0d147aefeea..f7cb42cec51c 100644 --- a/docs/nspr/reference/prthreadstack.rst +++ b/docs/nspr/reference/prthreadstack.rst @@ -27,5 +27,5 @@ Syntax .. _Definition_2: - + - diff --git a/docs/setup/configuring_build_options.rst b/docs/setup/configuring_build_options.rst index 6b0f338bc504..6f8173cba200 100644 --- a/docs/setup/configuring_build_options.rst +++ b/docs/setup/configuring_build_options.rst @@ -290,7 +290,7 @@ Localization ^^^^^^^^^^^^ ``mk_add_options MOZ_CO_LOCALES=ISOcode`` - TBD. + TBD. ``ac_add_options --enable-ui-locale=ISOcode`` TBD. ``ac_add_options --with-l10n-base=/path/to/base/dir`` diff --git a/docs/setup/index.rst b/docs/setup/index.rst index 764b74fe9000..6688eee0aa94 100644 --- a/docs/setup/index.rst +++ b/docs/setup/index.rst @@ -4,7 +4,7 @@ Getting Set Up To Work On The Firefox Codebase This page will help you get set up to build Firefox on your own machine. .. toctree:: - :caption: Thank you for contributing to Firefox + :caption: Thank you for contributing to Firefox /contributing/contributing_to_mozilla diff --git a/dom/docs/ipc/mainthread.rst b/dom/docs/ipc/mainthread.rst index 5b1ce136c900..c04e8dc4849a 100644 --- a/dom/docs/ipc/mainthread.rst +++ b/dom/docs/ipc/mainthread.rst @@ -10,4 +10,4 @@ TODO Fission Actor Diagram ===================== -.. image:: Fission-IPC-Diagram.svg \ No newline at end of file +.. image:: Fission-IPC-Diagram.svg diff --git a/dom/docs/navigation/embedding.rst b/dom/docs/navigation/embedding.rst index b213b03ea4f6..a42aabc6f5c7 100644 --- a/dom/docs/navigation/embedding.rst +++ b/dom/docs/navigation/embedding.rst @@ -90,4 +90,3 @@ lines are a stronger lifetime relationship. label = "Synced Contexts"; "BrowsingContext" "WindowContext"; } - diff --git a/dom/docs/workersAndStorage/CodeStyle.rst b/dom/docs/workersAndStorage/CodeStyle.rst index 648de62c3805..94d34e0480c4 100644 --- a/dom/docs/workersAndStorage/CodeStyle.rst +++ b/dom/docs/workersAndStorage/CodeStyle.rst @@ -328,7 +328,7 @@ base, or where it is difficult to reach a consensus at the global scope, may make sense to be kept in the local style. The details of synchronizing with the global style are subject to discussion -with the owner and peers of the global coding style (see +with the owner and peers of the global coding style (see `Bug 1587810 `). FAQ @@ -354,4 +354,3 @@ FAQ Personal preferences regarding the degree may differ, but in doubt such inconsistencies should be considered acceptable. They should not block a bug from being closed. - diff --git a/gfx/docs/AsyncPanZoom.rst b/gfx/docs/AsyncPanZoom.rst index dd94b718a004..f8805a196f4a 100644 --- a/gfx/docs/AsyncPanZoom.rst +++ b/gfx/docs/AsyncPanZoom.rst @@ -50,7 +50,7 @@ into a multithreaded variant which looks something like this: send a copy of input to thread 2 adjust rendered content based on input display adjusted rendered content - + Thread 2 (main thread) while true: receive input from thread 1 @@ -381,7 +381,7 @@ e.g. steps 6 and 8 involve IPC, not just "stack unwinding"). hit-test to see which APZC it hits. If no APZC is hit, the events are discarded and we jump to step 6. Otherwise, the input block is tagged with the hit APZC as a tentative target and put into a global APZ - input queue. In addition the target APZC, the result of the hit test + input queue. In addition the target APZC, the result of the hit test also includes whether the input event landed on a "dispatch-to-content" region. These are regions of the page where there is something going on that requires dispatching the event to content and waiting for @@ -442,12 +442,12 @@ e.g. steps 6 and 8 involve IPC, not just "stack unwinding"). events may trigger behaviours like scrolling or tap gestures. If the CSS touch-action property is enabled, the above steps are -modified as follows: +modified as follows: * In step 4, the APZC also requires the allowed touch-action behaviours for the input event. This might have been determined as part of the hit-test in APZCTreeManager; if not, the events are queued. -* In step 6, the widget code determines the content element at the point +* In step 6, the widget code determines the content element at the point under the input element, and notifies the APZ code of the allowed touch-action behaviours. This notification is sent via a call to APZCTreeManager::SetAllowedTouchBehavior on the input thread. diff --git a/intl/docs/icu.rst b/intl/docs/icu.rst index cc017ac21925..94b15a63ab6f 100644 --- a/intl/docs/icu.rst +++ b/intl/docs/icu.rst @@ -285,4 +285,3 @@ When the list of supported numbering systems needs to be updated, run ``make_int $ # make_intl_data.py requires yaml. $ export PYTHONPATH="$topsrcdir/third_party/python/PyYAML/lib3/" $ python3 ./make_intl_data.py numbering - diff --git a/intl/l10n/docs/crosschannel/content.rst b/intl/l10n/docs/crosschannel/content.rst index dfbea76a93eb..2ff7930782e2 100644 --- a/intl/l10n/docs/crosschannel/content.rst +++ b/intl/l10n/docs/crosschannel/content.rst @@ -56,7 +56,7 @@ Created Content Structure The created content is laid out in the directory in the same structure as the files in ``l10n-central``. The localizable files end up like this: -.. code-block:: +.. code-block:: browser/ browser/ diff --git a/intl/l10n/docs/crosschannel/graph.rst b/intl/l10n/docs/crosschannel/graph.rst index d3ad60cf9a62..6558b9b9c2b2 100644 --- a/intl/l10n/docs/crosschannel/graph.rst +++ b/intl/l10n/docs/crosschannel/graph.rst @@ -198,4 +198,4 @@ additional merge commits. The algorithm for finding good candidates for this corresponds to the algorithm we used when ensuring a single head on the update. With a known state of the changeset to convert, we'll describe the context -with which the content is generated in the next section. +with which the content is generated in the next section. diff --git a/intl/l10n/docs/crosschannel/index.rst b/intl/l10n/docs/crosschannel/index.rst index 263d62dfbbb7..24c8649d876b 100644 --- a/intl/l10n/docs/crosschannel/index.rst +++ b/intl/l10n/docs/crosschannel/index.rst @@ -78,7 +78,7 @@ The last item is the easiest, as ``mozilla-*`` and ``comm-*`` don't share code or history. Thus, they're converted individually to disjunct directories and files in the target repository, and the Mercurial history of each is interleaved in the target history. When parents are needed for one repository, they're -rebased over the commits for the other. +rebased over the commits for the other. .. toctree:: :maxdepth: 1 diff --git a/intl/l10n/docs/fluent/tutorial.rst b/intl/l10n/docs/fluent/tutorial.rst index 425924ba6a63..974baf3a191f 100644 --- a/intl/l10n/docs/fluent/tutorial.rst +++ b/intl/l10n/docs/fluent/tutorial.rst @@ -123,7 +123,7 @@ a more complex example like: -brand-short-name = Firefox .gender = masculine - + pref-pane = .title = { PLATFORM() -> @@ -131,7 +131,7 @@ a more complex example like: *[other] Preferences } .accesskey = C - + # Variables: # $tabCount (Number) - number of container tabs to be closed containers-disable-alert-ok-button = @@ -139,7 +139,7 @@ a more complex example like: [one] Close { $tabCount } Container Tab *[other] Close { $tabCount } Container Tabs } - + update-application-info = You are using { -brand-short-name } Version: { $version }. Please read the privacy policy. @@ -575,11 +575,11 @@ makes it relatively easy. In case of localization, the recommended way is to tes the code sets the right :code:`l10n-id`/:code:`l10n-args` attributes like this: .. code-block:: javascript - + testedFunction(); - + const l10nAttrs = document.l10n.getAttributes(element); - + deepEquals(l10nAttrs, { id: "my-expected-id", args: { @@ -593,7 +593,7 @@ always better to scan for a variable: .. code-block:: javascript testedFunction(); - + equals(element.textContent.contains("John")); .. important:: diff --git a/intl/l10n/docs/glossary.rst b/intl/l10n/docs/glossary.rst index 0fc33aa3f34c..87dad34e0e1e 100644 --- a/intl/l10n/docs/glossary.rst +++ b/intl/l10n/docs/glossary.rst @@ -10,7 +10,7 @@ L10N Glossary Localizability Enabling a piece of software to be localized. This is mostly - externalizing English strings, and writing build support to + externalizing English strings, and writing build support to pick up localized search engines etc. L10n diff --git a/ipc/docs/ipdl.rst b/ipc/docs/ipdl.rst index 9c9ac049705b..ed9862014b00 100644 --- a/ipc/docs/ipdl.rst +++ b/ipc/docs/ipdl.rst @@ -91,7 +91,7 @@ Using The IPDL compiler To build IPDL files, list them (alphabetically sorted) in a ``moz.build`` file. In this example, the ``.ipdl`` and ``.ipdlh`` files would be alongside a ``moz.build`` containing: .. code-block:: c++ - + IPDL_SOURCES += [ "MyTypes.ipdlh", "PMyManaged.ipdl", @@ -110,7 +110,7 @@ To build IPDL files, list them (alphabetically sorted) in a ``moz.build`` file. ``chromium-config.mozbuild`` sets up paths so that generated IPDL header files are in the proper scope. If it isn't included, the build will fail with ``#include`` errors in both your actor code and some internal ipc headers. For example: .. code-block:: c++ - + c:/mozilla-src/mozilla-unified/obj-64/dist/include\ipc/IPCMessageUtils.h(13,10): fatal error: 'build/build_config.h' file not found ``.ipdl`` files are compiled to C++ files as one of the earliest post-configure build steps. Those files are, in turn, referenced throughout the source code and build process. From ``PMyManager.ipdl`` the compiler generates two header files added to the build context and exported globally: ``mozilla/myns/PMyManagerParent.h`` and ``mozilla/myns/PMyManagerChild.h``, as discussed in `Namespaces`_ below. These files contain the base classes for the actors. It also makes several other files, including C++ source files and another header, that are automatically included into the build and should not require attention. @@ -174,7 +174,7 @@ Generating IPDL-Aware C++ Data Types: IPDL Structs and Unions .. code-block:: c++ [Comparable] union MyUnion { - float; + float; MyOtherData; }; @@ -350,7 +350,7 @@ The following is a list of the keywords and operators that have been introduced ``nullable`` Indicates that an actor reference in an IPDL type may be null when sent over IPC. ``protocol`` An IPDL protocol (actor) definition. ``sync/async`` These are used in two cases: (1) to indicate whether a message blocks as it waits for a result and - (2) because an actor that contains ``sync`` messages must itself be labeled ``sync`` or ``intr``. + (2) because an actor that contains ``sync`` messages must itself be labeled ``sync`` or ``intr``. ``[NestedUpTo=inside_sync]`` Indicates that an actor contains [Nested=inside_sync] messages, in addition to normal messages. ``[NestedUpTo=inside_cpow]`` Indicates that an actor contains [Nested=inside_cpow] messages, in addition to normal messages. ``intr`` Used to indicate either that (1) an actor contains ``sync``, ``async`` and (deprecated) ``intr`` messages, @@ -371,7 +371,7 @@ The following is a list of the keywords and operators that have been introduced ``String`` Translated into ``nsString`` in C++. ``?`` When following a type T in an IPDL data structure or message parameter, the parameter is translated into ``Maybe`` in C++. -``[]`` When following a type T in an IPDL data structure or message parameter, +``[]`` When following a type T in an IPDL data structure or message parameter, the parameter is translated into ``nsTArray`` in C++. ``[Tainted]`` Used to indicate that a message's handler should receive parameters that it is required to manually validate. Parameters of type ``T`` become ``Tainted`` in C++. @@ -507,7 +507,7 @@ A special case worth mentioning is that of enums. Enums are a common source of enum MyActorEnum { e1, e2, e3, e4, e5 }; - template<> + template<> struct ParamTraits : public ContiguousEnumSerializerInclusive {}; @@ -519,7 +519,7 @@ IPDL structs and unions become C++ classes that provide interfaces that are fair .. code-block:: c++ union MyUnion { - float; + float; MyOtherData; }; @@ -541,7 +541,7 @@ These compile to: MyUnion& operator=(MyOtherData&& aOD); operator float&(); operator MyOtherData&(); - }; + }; class MyActorPair { MyActorPair(PMyManagedParent* actor1Parent, PMyManagedChild* actor1Child, @@ -595,7 +595,7 @@ So ``MyManagerParent.h`` looks like this: }; } // namespace myns - } // namespace mozilla + } // namespace mozilla All messages that can be sent to the actor must be handled by ``Recv`` methods in the proper actor subclass. They should return ``IPC_OK()`` on success and ``IPC_FAIL(actor, reason)`` if an error occurred (where ``actor`` is ``this`` and ``reason`` is a human text explanation) that should be considered a failure to process the message. The handling of such a failure is specific to the process type. @@ -628,7 +628,7 @@ Send methods that are not for async messages with return values follow a simpler bool SendSomeMsg(const Maybe& aActors, const nsTArray& aMyData, int32_t& x, int32_t& y, MyUnion& aUnion); -Since it is sync, this method will not return to its caller until the response is received or an error is detected. +Since it is sync, this method will not return to its caller until the response is received or an error is detected. All calls to ``Send`` methods, like all messages handler ``Recv`` methods, must only be called on the worker thread for the actor. @@ -747,7 +747,7 @@ The destruction of actors is as unusual as their construction. Unlike construct Additionally, the ``__delete__`` message tells IPDL to disconnect both the given actor *and all of its managed actors*. So it is really deleting the actor subtree, although ``Recv__delete__`` is only called for the actor it was sent to. -During the call to ``Send__delete__``, or after the call to ``Recv__delete__``, the actor's ``ActorDestroy`` method is called. This method gives client code a chance to do any teardown that must happen in `all` circumstances were it is possible -- both expected and unexpected. This means that ``ActorDestroy`` will also be called when, for example, IPDL detects that the other endpoint has terminated unexpectedly, so it is releasing its reference to the actor, or because an ancestral manager (manager or manager's manager...) received a ``__delete__``. The only way for an actor to avoid ``ActorDestroy`` is for its process to crash first. ``ActorDestroy`` is always run after its actor is disconnected so it is pointless to try to send messages from it. +During the call to ``Send__delete__``, or after the call to ``Recv__delete__``, the actor's ``ActorDestroy`` method is called. This method gives client code a chance to do any teardown that must happen in `all` circumstances were it is possible -- both expected and unexpected. This means that ``ActorDestroy`` will also be called when, for example, IPDL detects that the other endpoint has terminated unexpectedly, so it is releasing its reference to the actor, or because an ancestral manager (manager or manager's manager...) received a ``__delete__``. The only way for an actor to avoid ``ActorDestroy`` is for its process to crash first. ``ActorDestroy`` is always run after its actor is disconnected so it is pointless to try to send messages from it. Why use ``ActorDestroy`` instead of the actor's destructor? ``ActorDestroy`` gives a chance to clean up things that are only used for communication and therefore don't need to live for however long the actor's (reference-counted) object does. For example, you might have references to shared memory (Shmems) that are no longer valid. Or perhaps the actor can now release a cache of data that was only needed for processing messages. It is cleaner to deal with communication-related objects in ``ActorDestroy``, where they become invalid, than to leave them in limbo until the destructor is run. @@ -898,7 +898,7 @@ A hypothetical layout of ``PBackground`` threads, demonstrating some of the proc stm --> mt1 st1 --> mt1 - st2 --> mt1 + st2 --> mt1 Creating background actors is done a bit differently than normal managees. The new managed type and constructor are still added to ``PBackground.ipdl`` as with normal managees but, instead of ``new``-ing the child actor and then passing it in a ``SendFooConstructor`` call, background actors issue the send call to the ``BackgroundChild`` manager, which returns the new child: @@ -1038,4 +1038,3 @@ The environment variable ``MOZ_IPC_MESSAGE_LOG`` controls the logging of IPC mes .. important:: The preceeding ``P`` and the ``Parent`` or ``Child`` suffix are required when listing individual protocols in ``MOZ_IPC_MESSAGE_LOG``. - diff --git a/ipc/docs/processes.rst b/ipc/docs/processes.rst index 1cb1463b4f0e..8e0a84059712 100644 --- a/ipc/docs/processes.rst +++ b/ipc/docs/processes.rst @@ -27,7 +27,7 @@ Informed by this history, there is some of non-obvious preparation that you shou Firefox Process Hierarchy ------------------------- -This diagram shows the primary process types in Firefox. +This diagram shows the primary process types in Firefox. .. mermaid:: @@ -372,7 +372,7 @@ Gecko processes have a clean way for clients to request that they shutdown. Sim .. note:: There is no need to consider the case where the parent (main) process crashed, because the Dummy process would be quickly terminated by Gecko. -In cases where ``Close()`` is called, the shutdown procedure is fairly straightforward. Once the call completes, the actor is no longer connected to a channel -- messages will not be sent or received, as is the case with a normal top-level actor (or any managed actor after calling ``Send__delete__()``). In the sample code, we ``Close`` the ``DummyChild`` when some (as yet unwritten) dummy process code calls ``DummyChild::Shutdown``. +In cases where ``Close()`` is called, the shutdown procedure is fairly straightforward. Once the call completes, the actor is no longer connected to a channel -- messages will not be sent or received, as is the case with a normal top-level actor (or any managed actor after calling ``Send__delete__()``). In the sample code, we ``Close`` the ``DummyChild`` when some (as yet unwritten) dummy process code calls ``DummyChild::Shutdown``. .. code-block:: c++ @@ -734,5 +734,3 @@ Pausing for the debugger is not a panacea. Since the environmental varaiables a .. _Child Process Debugging Tool: https://marketplace.visualstudio.com/items?itemName=vsdbgplat.MicrosoftChildProcessDebuggingPowerTool .. _.childdbg: https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/-childdbg--debug-child-processes- - - diff --git a/js/src/doc/test.rst b/js/src/doc/test.rst index 79402b2d7e74..6c2e8de4d61d 100644 --- a/js/src/doc/test.rst +++ b/js/src/doc/test.rst @@ -47,7 +47,7 @@ The Test262 tests can also be run in the browser, using: To run a specific test, you can use the ``--filter=PATTERN`` option, where PATTERN is a RegExp pattern that is tested against ``file:///{PATH_TO_OBJ_DIR}/dist/test-stage/jsreftest/tests/jsreftest.html?test={RELATIVE_PATH_TO_TEST_FROM_js/src/tests}``. -For historical reasons, ``jstests`` also includes a SpiderMonkey specific suite of additional language feature tests in ``js/src/tests/non262``. +For historical reasons, ``jstests`` also includes a SpiderMonkey specific suite of additional language feature tests in ``js/src/tests/non262``. Running jit-tests locally ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/layout/docs/index.rst b/layout/docs/index.rst index c866eb39e4b4..da1e7d422503 100644 --- a/layout/docs/index.rst +++ b/layout/docs/index.rst @@ -11,4 +11,3 @@ contains general information about layout and the layout team at Mozilla. :maxdepth: 1 AccessibleCaret - diff --git a/mobile/android/docs/geckoview/consumer/geckoview-quick-start.rst b/mobile/android/docs/geckoview/consumer/geckoview-quick-start.rst index 60648b0c1a7d..b87d79713fcc 100644 --- a/mobile/android/docs/geckoview/consumer/geckoview-quick-start.rst +++ b/mobile/android/docs/geckoview/consumer/geckoview-quick-start.rst @@ -7,7 +7,7 @@ How to use GeckoView in your Android app. *Building a browser? Check out* `Android Components `_, *our collection of ready-to-use support libraries!* -The following article is a brief guide to embedding GeckoView in an app. For a more in depth tutorial on getting started with GeckoView please read the article we have published on `raywenderlich.com `_. +The following article is a brief guide to embedding GeckoView in an app. For a more in depth tutorial on getting started with GeckoView please read the article we have published on `raywenderlich.com `_. .. contents:: :local: @@ -20,7 +20,7 @@ You need to add or edit four stanzas inside your module's ``build.gradle`` file. *Like Firefox, GeckoView has three release channels: Stable, Beta, and Nightly. Browse the* `Maven Repository `_ *to see currently available builds.* -.. code-block:: groovy +.. code-block:: groovy ext { geckoviewChannel = @@ -30,7 +30,7 @@ You need to add or edit four stanzas inside your module's ``build.gradle`` file. **2. Add Mozilla's Maven repository** -.. code-block:: groovy +.. code-block:: groovy repositories { maven { @@ -43,7 +43,7 @@ You need to add or edit four stanzas inside your module's ``build.gradle`` file. As GeckoView uses some Java 11 APIs, it requires these compatibility flags: -.. code-block:: groovy +.. code-block:: groovy compileOptions { sourceCompatibility JavaVersion.VERSION_11 @@ -52,11 +52,11 @@ As GeckoView uses some Java 11 APIs, it requires these compatibility flags: **4. Add GeckoView Implementations** -.. code-block:: groovy +.. code-block:: groovy dependencies { // ... - implementation "org.mozilla.geckoview:geckoview-${geckoviewChannel}:${geckoviewVersion}" + implementation "org.mozilla.geckoview:geckoview-${geckoviewChannel}:${geckoviewVersion}" } Add GeckoView to a Layout @@ -64,7 +64,7 @@ Add GeckoView to a Layout Inside a layout ``.xml`` file, add the following: -.. code-block:: xml +.. code-block:: xml `_. -.. _Callback: https://mozilla.github.io/geckoview/https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession.PermissionDelegate.Callback.html \ No newline at end of file +.. _Callback: https://mozilla.github.io/geckoview/https://mozilla.github.io/geckoview/javadoc/mozilla-central/org/mozilla/geckoview/GeckoSession.PermissionDelegate.Callback.html diff --git a/mobile/android/docs/geckoview/contributor/contributing-to-mc.rst b/mobile/android/docs/geckoview/contributor/contributing-to-mc.rst index 341a23c72ba3..9c42aeccc09c 100644 --- a/mobile/android/docs/geckoview/contributor/contributing-to-mc.rst +++ b/mobile/android/docs/geckoview/contributor/contributing-to-mc.rst @@ -53,7 +53,7 @@ are three levels of commit access that give increasing levels of access to the repositories. Level 1: Try/User access. You will need this level of access commit to -the try server. +the try server. Level 2: General access. This will give you full commit access to any mercurial or SVN repository not requiring level 3 access. diff --git a/mobile/android/docs/geckoview/contributor/geckoview-quick-start.rst b/mobile/android/docs/geckoview/contributor/geckoview-quick-start.rst index a83aa1cd6c23..b9ca961558a8 100644 --- a/mobile/android/docs/geckoview/contributor/geckoview-quick-start.rst +++ b/mobile/android/docs/geckoview/contributor/geckoview-quick-start.rst @@ -232,9 +232,9 @@ review your patch, put their Phabricator handle against the If you don’t know who to tag for a review in the Phabricator submission message, leave the field blank and, after submission, follow the link to the patch in Phabricator and scroll to the bottom of the screen until -you see the comment box. +you see the comment box. -- Select the ``Add Action`` drop down and pick the ``Change Reviewers`` option. +- Select the ``Add Action`` drop down and pick the ``Change Reviewers`` option. - In the presented box, add ``geckoview-reviewers``. Selecting this group as the reviewer will notify all the members of the GeckoView team there is a patch to review. - Click ``Submit`` to submit the reviewer change request. @@ -270,9 +270,9 @@ Dependency substiting your local GeckoView into a Mozilla project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Most GeckoView-consuming projects produced by Mozilla support dependency -substitution via ``local.properties``. These projects include: +substitution via ``local.properties``. These projects include: -- `Fenix `_ +- `Fenix `_ - `reference-browser `_ - `android-components `_ - `Firefox Reality `_ diff --git a/mobile/android/docs/index.rst b/mobile/android/docs/index.rst index 30443dd4f48e..8a824d0abf4e 100644 --- a/mobile/android/docs/index.rst +++ b/mobile/android/docs/index.rst @@ -8,4 +8,4 @@ which are still useful for other projects :maxdepth: 1 adjust - mma \ No newline at end of file + mma diff --git a/netwerk/docs/cache2/doc.rst b/netwerk/docs/cache2/doc.rst index 24c95bf703af..71982be9e634 100644 --- a/netwerk/docs/cache2/doc.rst +++ b/netwerk/docs/cache2/doc.rst @@ -51,7 +51,7 @@ nsICacheStorageService version in a group) in hands, this storage will provide read and write access to entries in that application cache; when the app cache is not specified, this storage will operate over all - existing app caches. **This kind of storage is deprecated and will be removed** in `bug 1694662 `_ + existing app caches. **This kind of storage is deprecated and will be removed** in `bug 1694662 `_ - The service also provides methods to clear the whole disk and memory cache content or purge any intermediate memory structures: @@ -128,7 +128,7 @@ nsICacheEntryOpenCallback - These callbacks are ensured to be invoked when ``asyncOpenURI`` returns ``NS_OK``. -- +- .. note:: @@ -540,7 +540,7 @@ cache entries' meta data in memory for immediate zero-thread-loop opening. The default size of this meta data memory pool is only 250kB and is controlled by a new ``browser.cache.disk.metadata_memory_limit`` preference. When the limit is exceeded, we purge (throw away) first -**expired** and then **least used** entries to free up memory again. +**expired** and then **least used** entries to free up memory again. Only ``CacheEntry`` objects that are already loaded and filled with data and having the 'consumer reference == 0' (`bug diff --git a/python/devtools/migrate-l10n/README.rst b/python/devtools/migrate-l10n/README.rst index 70f5a63033cf..bd0b4cc5770d 100644 --- a/python/devtools/migrate-l10n/README.rst +++ b/python/devtools/migrate-l10n/README.rst @@ -1,16 +1,16 @@ -devtools-l10n-migration script -============================== - -For devtools.html, devtools will no longer rely on DTD files. This migration -script is aimed at localizers to automate the migration of strings from DTD to -properties files. - -How to run this script? - -To migrate all configuration files: - python migrate/main.py path/to/your/l10n/repo/ -c migrate/conf/ - -To migrate only one configuration file: - python migrate/main.py path/to/your/l10n/repo/ -c migrate/conf/bug1294186 - -All configuration files should be named after the bug where specific devtools strings were migrated. +devtools-l10n-migration script +============================== + +For devtools.html, devtools will no longer rely on DTD files. This migration +script is aimed at localizers to automate the migration of strings from DTD to +properties files. + +How to run this script? + +To migrate all configuration files: + python migrate/main.py path/to/your/l10n/repo/ -c migrate/conf/ + +To migrate only one configuration file: + python migrate/main.py path/to/your/l10n/repo/ -c migrate/conf/bug1294186 + +All configuration files should be named after the bug where specific devtools strings were migrated. diff --git a/python/mach/docs/faq.rst b/python/mach/docs/faq.rst index 6413e8b44da6..6dd6e0eb6430 100644 --- a/python/mach/docs/faq.rst +++ b/python/mach/docs/faq.rst @@ -120,4 +120,3 @@ Who do I contact for help or to report issues? You can ask questions in `#build `__. - diff --git a/python/mach/docs/windows-usage-outside-mozillabuild.rst b/python/mach/docs/windows-usage-outside-mozillabuild.rst index 95d941a1d257..f2192f535706 100644 --- a/python/mach/docs/windows-usage-outside-mozillabuild.rst +++ b/python/mach/docs/windows-usage-outside-mozillabuild.rst @@ -1,97 +1,97 @@ -========================================== -Using Mach on Windows Outside MozillaBuild -========================================== - -.. note:: - - These docs still require that you've followed the :ref:`Building Firefox On Windows` guide. - -`MozillaBuild `__ is required to build -Firefox on Windows, because it provides necessary unix-y tools such as ``sh`` and ``awk``. - -Traditionally, to interact with Mach and the Firefox Build System, Windows -developers would have to do so from within the MozillaBuild shell. This could be -disadvantageous for two main reasons: - -1. The MozillaBuild environment is unix-y and based on ``bash``, which may be unfamiliar - for developers used to the Windows Command Prompt or Powershell. -2. There have been long-standing stability issues with MozillaBuild - this is due to - the fragile interface point between the underlying "MSYS" tools and "native Windows" - binaries. - -It is now (experimentally!) possible to invoke Mach directly from other command line -environments, such as Powershell, Command Prompt, or even a developer-managed MSYS2 -environment. Windows Terminal should work as well, for those on the "cutting edge". - -.. note:: - - If you're using a Cygwin-based environment such as MSYS2, it'll probably be - best to use the Windows-native version of Python (as described below) instead of a Python - distribution provided by the environment's package manager. Otherwise you'll likely run into - compatibility issues: - - * Cygin/MSYS Python will run into compatibility issues with Mach due to its unexpected Unix-y - conventions despite Mach assuming it's on a "Windows" platform. Additionally, there may - be performance issues. - * MinGW Python will encounter issues building native packages because they'll expect the - MSVC toolchain. - -.. warning:: - - This is only recommended for more advanced Windows developers: this work is experimental - and may run into unexpected failures! - -Following are steps for preparing Windows-native (Command Prompt/Powershell) usage of Mach: - -1. Install Python -~~~~~~~~~~~~~~~~~ - -Download Python from the `the official website `__. - -.. note:: - - To avoid Mach compatibility issues with recent Python releases, it's recommended to install - the 2nd-most recent "major version". For example, at time of writing, the current modern Python - version is 3.10.1, so a safe version to install would be the most recent 3.9 release. - -You'll want to download the "Windows installer (64-bit)" associated with the release you've chosen. -During installation, ensure that you check the "Add Python 3.x to PATH" option, otherwise you might -`encounter issues running Mercurial `__. - -.. note:: - - Due to issues with Python DLL import failures with pip-installed binaries, it's not - recommended to use the Windows Store release of Python. - -2. Modify your PATH -~~~~~~~~~~~~~~~~~~~ - -The Python "user site-packages directory" needs to be added to your ``PATH`` so that packages -installed via ``pip install --user`` (such as ``hg``) can be invoked from the command-line. - -1. From the Start menu, go to the Control Panel entry for "Edit environment variables - for your account". -2. Double-click the ``Path`` row in the top list of variables. Click "New" to add a new item to - the list. -3. In a Command Prompt window, resolve the Python directory with the command - ``python -c "import site; import os; print(os.path.abspath(os.path.join(site.getusersitepackages(), '..', 'Scripts')))"``. -4. Paste the output into the new item entry in the "Edit environment variable" window. -5. Click "New" again, and add the ``bin`` folder of MozillaBuild: probably ``C:\mozilla-build\bin``. -6. Click "OK". - -3. Install Version Control System -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you're using Mercurial, you'll need to install it to your Windows-native Python: - -.. code-block:: shell - - pip3 install --user mercurial windows-curses - -If you're using Git with Cinnabar, follow its `setup instructions `__. - -Success! -~~~~~~~~ - -At this point, you should be able to invoke Mach and manage your version control system outside -of MozillaBuild. +========================================== +Using Mach on Windows Outside MozillaBuild +========================================== + +.. note:: + + These docs still require that you've followed the :ref:`Building Firefox On Windows` guide. + +`MozillaBuild `__ is required to build +Firefox on Windows, because it provides necessary unix-y tools such as ``sh`` and ``awk``. + +Traditionally, to interact with Mach and the Firefox Build System, Windows +developers would have to do so from within the MozillaBuild shell. This could be +disadvantageous for two main reasons: + +1. The MozillaBuild environment is unix-y and based on ``bash``, which may be unfamiliar + for developers used to the Windows Command Prompt or Powershell. +2. There have been long-standing stability issues with MozillaBuild - this is due to + the fragile interface point between the underlying "MSYS" tools and "native Windows" + binaries. + +It is now (experimentally!) possible to invoke Mach directly from other command line +environments, such as Powershell, Command Prompt, or even a developer-managed MSYS2 +environment. Windows Terminal should work as well, for those on the "cutting edge". + +.. note:: + + If you're using a Cygwin-based environment such as MSYS2, it'll probably be + best to use the Windows-native version of Python (as described below) instead of a Python + distribution provided by the environment's package manager. Otherwise you'll likely run into + compatibility issues: + + * Cygin/MSYS Python will run into compatibility issues with Mach due to its unexpected Unix-y + conventions despite Mach assuming it's on a "Windows" platform. Additionally, there may + be performance issues. + * MinGW Python will encounter issues building native packages because they'll expect the + MSVC toolchain. + +.. warning:: + + This is only recommended for more advanced Windows developers: this work is experimental + and may run into unexpected failures! + +Following are steps for preparing Windows-native (Command Prompt/Powershell) usage of Mach: + +1. Install Python +~~~~~~~~~~~~~~~~~ + +Download Python from the `the official website `__. + +.. note:: + + To avoid Mach compatibility issues with recent Python releases, it's recommended to install + the 2nd-most recent "major version". For example, at time of writing, the current modern Python + version is 3.10.1, so a safe version to install would be the most recent 3.9 release. + +You'll want to download the "Windows installer (64-bit)" associated with the release you've chosen. +During installation, ensure that you check the "Add Python 3.x to PATH" option, otherwise you might +`encounter issues running Mercurial `__. + +.. note:: + + Due to issues with Python DLL import failures with pip-installed binaries, it's not + recommended to use the Windows Store release of Python. + +2. Modify your PATH +~~~~~~~~~~~~~~~~~~~ + +The Python "user site-packages directory" needs to be added to your ``PATH`` so that packages +installed via ``pip install --user`` (such as ``hg``) can be invoked from the command-line. + +1. From the Start menu, go to the Control Panel entry for "Edit environment variables + for your account". +2. Double-click the ``Path`` row in the top list of variables. Click "New" to add a new item to + the list. +3. In a Command Prompt window, resolve the Python directory with the command + ``python -c "import site; import os; print(os.path.abspath(os.path.join(site.getusersitepackages(), '..', 'Scripts')))"``. +4. Paste the output into the new item entry in the "Edit environment variable" window. +5. Click "New" again, and add the ``bin`` folder of MozillaBuild: probably ``C:\mozilla-build\bin``. +6. Click "OK". + +3. Install Version Control System +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you're using Mercurial, you'll need to install it to your Windows-native Python: + +.. code-block:: shell + + pip3 install --user mercurial windows-curses + +If you're using Git with Cinnabar, follow its `setup instructions `__. + +Success! +~~~~~~~~ + +At this point, you should be able to invoke Mach and manage your version control system outside +of MozillaBuild. diff --git a/services/sync/docs/engines.rst b/services/sync/docs/engines.rst index 2273add96c79..7a4fa721afca 100644 --- a/services/sync/docs/engines.rst +++ b/services/sync/docs/engines.rst @@ -125,7 +125,7 @@ WebExt-Storage webext-storage is implemented in Rust and lives in `application services `_ -and is vendored into the `addons code `_ - +and is vendored into the `addons code `_ - note that this includes the storage *and* Sync code. The Sync engine itself is a shim in the sync directory. diff --git a/services/sync/docs/index.rst b/services/sync/docs/index.rst index 919400c607f0..a484332f3d89 100644 --- a/services/sync/docs/index.rst +++ b/services/sync/docs/index.rst @@ -14,4 +14,3 @@ which can help with this. engines rust-engines external - diff --git a/taskcluster/docs/how-tos.rst b/taskcluster/docs/how-tos.rst index a9952eae8504..9f6de08b1d83 100644 --- a/taskcluster/docs/how-tos.rst +++ b/taskcluster/docs/how-tos.rst @@ -243,5 +243,3 @@ Something Else? If you make another change not described here that turns out to be simple or common, please include an update to this file in your patch. - - diff --git a/taskcluster/docs/optimization-process.rst b/taskcluster/docs/optimization-process.rst index 4ead2094f072..388b7848e62b 100644 --- a/taskcluster/docs/optimization-process.rst +++ b/taskcluster/docs/optimization-process.rst @@ -75,4 +75,3 @@ outside of the taskgraph (for replacement tasks). As a side-effect, this phase also expands all ``{"task-reference": ".."}`` and ``{"artifact-reference": ".."}`` objects within the task definitions. - diff --git a/taskcluster/docs/platforms.rst b/taskcluster/docs/platforms.rst index e9f114d5aa03..e73f1cb82ea9 100644 --- a/taskcluster/docs/platforms.rst +++ b/taskcluster/docs/platforms.rst @@ -39,20 +39,20 @@ Build Platforms OS X Cross Compiled DevEdition, , OS X 10.14, , OS X 10.14 WebRender, Jeff Muizelaar, Build with WebRender - OS X 10.14 Shippable, , + OS X 10.14 Shippable, , OS X 10.14 WebRender Shippable, Jeff Muizelaar, Build with WebRender - OS X 10.14 DevEdition, , + OS X 10.14 DevEdition, , Windows 2012, , Windows 2012 shippable, , What we ship to our users - Windows 2012 addon, , + Windows 2012 addon, , Windows 2012 NoOpt, , "| Developer build - Disable optimizations, enable debug options | Only runs on m-c" - Windows 2012 DevEdition, , + Windows 2012 DevEdition, , Windows 2012 x64, , - Windows 2012 x64 shippable, , + Windows 2012 x64 shippable, , Windows 2012 AArch64, , - Windows 2012 AArch64 Shippable, , - Windows 2012 AArch64 DevEdition, , + Windows 2012 AArch64 Shippable, , + Windows 2012 AArch64 DevEdition, , Windows 2012 x64 addon, , Windows 2012 x64 NoOpt, , "| Developer build - Disable optimizations, enable debug options | Only runs on m-c" @@ -65,15 +65,15 @@ Build Platforms Android 4.1 API16+ Release, , To ship/test Android 4.1 on arm v7 CPU Android 4.1 API16+ GeckoView multi-arch fat AAR, , Android 5.0 AArch64, , - Android 5.0 AArch64 Beta, , - Android 5.0 AArch64 Release, , - Android 5.0 x86-64, , - Android 5.0 x86-64 Beta, , - Android 5.0 x86-64 Release, , - Android 7.0 x86, , - Android 7.0 x86 Beta, , - Android 7.0 x86 Release, , - Android 7.0 x86-64, , + Android 5.0 AArch64 Beta, , + Android 5.0 AArch64 Release, , + Android 5.0 x86-64, , + Android 5.0 x86-64 Beta, , + Android 5.0 x86-64 Release, , + Android 7.0 x86, , + Android 7.0 x86 Beta, , + Android 7.0 x86 Release, , + Android 7.0 x86-64, , Android 7.0 x86-64 WebRender, Kris Taeleman, Build and test GeckoView with WebRender Android 7.0 x86-64 Beta, , Android 7.0 x86-64 Release, , diff --git a/taskcluster/docs/release-promotion-action.rst b/taskcluster/docs/release-promotion-action.rst index e35d3573a080..e7f183f2b177 100644 --- a/taskcluster/docs/release-promotion-action.rst +++ b/taskcluster/docs/release-promotion-action.rst @@ -39,9 +39,9 @@ Now let's specify task group ``G1`` and ``G2`` as previous task group IDs. If ta \______ | \| t2 - + or - + G1 G2 G | | | t1 t0 | diff --git a/testing/condprofile/README.rst b/testing/condprofile/README.rst index 1fe4f95cb159..01b7fb73be90 100644 --- a/testing/condprofile/README.rst +++ b/testing/condprofile/README.rst @@ -112,4 +112,3 @@ In the example below, we install uBlock, set a pref, and pass the "heavy": {"max_urls": 10} } } - diff --git a/testing/mozbase/docs/mozfile.rst b/testing/mozbase/docs/mozfile.rst index 52e1cd4c9c86..3ab5492e90f5 100644 --- a/testing/mozbase/docs/mozfile.rst +++ b/testing/mozbase/docs/mozfile.rst @@ -7,4 +7,3 @@ directories. .. automodule:: mozfile :members: extract, extract_tarball, extract_zip, move, remove - diff --git a/testing/mozbase/docs/mozlog.rst b/testing/mozbase/docs/mozlog.rst index 6ef82b37093c..63e3614243c6 100644 --- a/testing/mozbase/docs/mozlog.rst +++ b/testing/mozbase/docs/mozlog.rst @@ -114,7 +114,7 @@ emitted: same as the actual result (string enum, same as ``status``). ``known_intermittent`` - A list of known intermittent statuses for that test. Omitted if there are + A list of known intermittent statuses for that test. Omitted if there are no intermittent statuses expected. (items in the list are string enum, same as ``status``) ``test_end`` @@ -137,7 +137,7 @@ emitted: actual status (string enum, same as ``status``). ``known_intermittent`` - A list of known intermittent statuses for that test. Omitted if there are + A list of known intermittent statuses for that test. Omitted if there are no intermittent statuses expected. (items in the list are string enum, same as ``status``) ``process_output`` diff --git a/testing/mozbase/docs/moznetwork.rst b/testing/mozbase/docs/moznetwork.rst index d6ed54b85269..905433e8a7ca 100644 --- a/testing/mozbase/docs/moznetwork.rst +++ b/testing/mozbase/docs/moznetwork.rst @@ -6,4 +6,3 @@ .. automethod:: moznetwork.get_ip .. autoclass:: moznetwork.NetworkError - diff --git a/testing/mozbase/docs/mozprocess.rst b/testing/mozbase/docs/mozprocess.rst index 1179d6c4effc..ef90e5aa0caf 100644 --- a/testing/mozbase/docs/mozprocess.rst +++ b/testing/mozbase/docs/mozprocess.rst @@ -77,7 +77,7 @@ In the following example the command's output will be stored in a file *output.l import sys from mozprocess import processhandler - + fd = open('output.log', 'w') def tostdout(line): @@ -197,7 +197,7 @@ Except on Windows, you can specify the signal with which to kill method the proc import time from mozprocess import processhandler - + command = './proc_sleep_echo.sh' # Windows: 'proc_sleep_echo.bat' p = processhandler.ProcessHandler(command) p.run() @@ -244,13 +244,13 @@ Consider the following scripts: #!/bin/sh ./proc_child.sh - for i in 1 2 3 4 5 + for i in 1 2 3 4 5 do echo $i sleep 1 done -For windows users consider: +For windows users consider: **proc_child.bat**: diff --git a/testing/mozbase/docs/mozprofile.rst b/testing/mozbase/docs/mozprofile.rst index 85428e835d11..543d8b89531f 100644 --- a/testing/mozbase/docs/mozprofile.rst +++ b/testing/mozbase/docs/mozprofile.rst @@ -85,7 +85,7 @@ their management. - ProfileManager_: XULRunner application for managing profiles. Has a GUI and CLI. - python-profilemanager_: python CLI interface similar to ProfileManager -- profile documentation_ +- profile documentation_ .. _Mozprofile: https://github.com/mozilla/mozbase/tree/master/mozprofile diff --git a/testing/mozbase/mozsystemmonitor/README.rst b/testing/mozbase/mozsystemmonitor/README.rst index 65756d44d35d..c8dad3767121 100644 --- a/testing/mozbase/mozsystemmonitor/README.rst +++ b/testing/mozbase/mozsystemmonitor/README.rst @@ -10,4 +10,3 @@ SystemResourceMonitor mozsystemmonitor.resourcemonitor.SystemResourceMonitor is class used to measure system resource usage. It is useful to get a handle on what an overall system is doing. - diff --git a/testing/mozharness/docs/index.rst b/testing/mozharness/docs/index.rst index e2c05d34a21c..04b3a2e38261 100644 --- a/testing/mozharness/docs/index.rst +++ b/testing/mozharness/docs/index.rst @@ -21,4 +21,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/toolkit/components/extensions/docs/background.rst b/toolkit/components/extensions/docs/background.rst index 71ce2a59d01e..ff3ddfd57d0e 100644 --- a/toolkit/components/extensions/docs/background.rst +++ b/toolkit/components/extensions/docs/background.rst @@ -131,4 +131,3 @@ a WebExtension API: possible -- extensions ared started relatively early in the browser startup process so any unnecessary work done during extension startup contributes directly to sluggish browser startup. - diff --git a/toolkit/components/extensions/docs/basics.rst b/toolkit/components/extensions/docs/basics.rst index ca20f22c4f9f..cd6c600004da 100644 --- a/toolkit/components/extensions/docs/basics.rst +++ b/toolkit/components/extensions/docs/basics.rst @@ -14,7 +14,7 @@ privileges. API implementations do not directly interact with extensions' Javascript environments, that is handled by the WebExtensions framework. Each API includes a schema that describes all the functions, events, and other properties that the API might inject into an -extension's Javascript environment. +extension's Javascript environment. Among other things, the schema specifies the namespace into which an API should be injected, what permissions (if any) are required to use it, and in which contexts (e.g., extension pages, content scripts, etc) @@ -243,7 +243,7 @@ all API scripts look to the following source: - Only available in the Desktop builds: `browser/components/extensions/parent/ext-browser.js `_ - Only available in the Android builds: - `mobile/android/components/extensions/ext-android.js `_ + `mobile/android/components/extensions/ext-android.js `_ .. warning:: The extension API authors should never redefine these globals to avoid introducing potential @@ -253,7 +253,7 @@ all API scripts look to the following source: WebIDL Bindings --------------- -In ``manifest_version: 3`` the extension will be able to declare a background service worker +In ``manifest_version: 3`` the extension will be able to declare a background service worker instead of a background page, and the existing WebExtensions API bindings can't be injected into this new extension global, because it lives off the main thread. diff --git a/toolkit/components/extensions/docs/events.rst b/toolkit/components/extensions/docs/events.rst index 991c72785b51..9ce59d0b0810 100644 --- a/toolkit/components/extensions/docs/events.rst +++ b/toolkit/components/extensions/docs/events.rst @@ -387,4 +387,3 @@ the ``unregister`` method. } } } - diff --git a/toolkit/components/extensions/docs/generate_webidl_from_jsonschema.rst b/toolkit/components/extensions/docs/generate_webidl_from_jsonschema.rst index fd7f3adcb00c..d49a71defb22 100644 --- a/toolkit/components/extensions/docs/generate_webidl_from_jsonschema.rst +++ b/toolkit/components/extensions/docs/generate_webidl_from_jsonschema.rst @@ -41,7 +41,7 @@ this command will generates a `.webdil` file named `dom/webidl/ExtensionRuntime. .. code-block:: $ mach python $SCRIPT_DIR/GenerateWebIDLBindings.py -- runtime - + Generating webidl definition for 'runtime' => dom/webidl/ExtensionRuntime.webidl Found existing dom/webidl/ExtensionRuntime.webidl. @@ -66,7 +66,7 @@ this command will generates a `.webdil` file named `dom/webidl/ExtensionRuntime. Overwrite dom/webidl/ExtensionRuntime.webidl? (Yes/No/Diff) * By convention each WebExtensions API WebIDL binding is expected to be paired with C++ files - named ``ExtensionMyNamespace.h`` and ``ExtensionMyNamespace.cpp`` and located in + named ``ExtensionMyNamespace.h`` and ``ExtensionMyNamespace.cpp`` and located in ``toolkit/components/extensions/webidl-api``: * if no files with the expected names is found the python script will generate an initial @@ -75,7 +75,7 @@ this command will generates a `.webdil` file named `dom/webidl/ExtensionRuntime. to apply the necessary changes (if any) when the webidl definitions are updated because of changes to the WebExtensions APIs JSONSchema. -``ExtensionWebIDL.conf`` config file +``ExtensionWebIDL.conf`` config file ------------------------------------ TODO: @@ -92,5 +92,3 @@ TODO: TODO: * mention the special webidl extended attribute used in the WebIDL definitions - - diff --git a/toolkit/components/extensions/docs/index.rst b/toolkit/components/extensions/docs/index.rst index 8c0751757458..63a7c3685c56 100644 --- a/toolkit/components/extensions/docs/index.rst +++ b/toolkit/components/extensions/docs/index.rst @@ -31,4 +31,3 @@ in particular. webext-storage other reference - diff --git a/toolkit/components/extensions/docs/lifecycle.rst b/toolkit/components/extensions/docs/lifecycle.rst index 2384bada8df4..af97f5c0d502 100644 --- a/toolkit/components/extensions/docs/lifecycle.rst +++ b/toolkit/components/extensions/docs/lifecycle.rst @@ -14,7 +14,7 @@ APIs that allocate any resources (e.g., adding elements to the browser's user interface, setting up internal event listeners, etc.) must free these resources when the extension for which they are allocated is shut down. An API does this by using the ``callOnClose()`` -method on an `Extension `_ object. +method on an `Extension `_ object. Extension Uninstall and Update ------------------------------ diff --git a/toolkit/components/extensions/docs/webidl_bindings.rst b/toolkit/components/extensions/docs/webidl_bindings.rst index 7fe64ab4681f..e48dd9aed902 100644 --- a/toolkit/components/extensions/docs/webidl_bindings.rst +++ b/toolkit/components/extensions/docs/webidl_bindings.rst @@ -5,7 +5,7 @@ While on ``manifest_version: 2`` all the extension globals (extension pages and that lives on the main thread and the WebExtensions API bindings can be injected into the extension global from the JS privileged code part of the WebExtensions internals (`See Schemas.inject defined in Schemas.jsm `_), -in ``manifest_version: 3`` the extension will be able to declare a background service worker +in ``manifest_version: 3`` the extension will be able to declare a background service worker instead of a background page, and the existing WebExtensions API bindings can't be injected into this new extension global, because it lives off of the main thread. @@ -13,7 +13,7 @@ To expose WebExtensions API bindings to the WebExtensions ``background.service_w we are in the process of generating new WebIDL bindings for the WebExtensions API. .. warning:: - + TODO: link to dom/webidl docs from this doc page for more general in depth details about WebIDL in Gecko. diff --git a/toolkit/components/extensions/docs/wiring_up_new_webidl_bindings.rst b/toolkit/components/extensions/docs/wiring_up_new_webidl_bindings.rst index 332d2ed72b8a..59088d707926 100644 --- a/toolkit/components/extensions/docs/wiring_up_new_webidl_bindings.rst +++ b/toolkit/components/extensions/docs/wiring_up_new_webidl_bindings.rst @@ -10,7 +10,7 @@ added in alphabetic order and nearby the other WebExtensions API bindings alread WebExtensions APIs): .. code-block:: - + # WebExtension API ... 'ExtensionRuntime': { diff --git a/toolkit/components/normandy/docs/services.rst b/toolkit/components/normandy/docs/services.rst index d765d2053e2b..6bec61a751c8 100644 --- a/toolkit/components/normandy/docs/services.rst +++ b/toolkit/components/normandy/docs/services.rst @@ -19,4 +19,4 @@ Classify Client This is a service that helps Normandy with filtering. It determines the region a user is in, based on IP. It also includes an up-to-date time and date. This allows Normandy to perform location and time based filtering -without having to rely on the local clock. \ No newline at end of file +without having to rely on the local clock. diff --git a/toolkit/components/normandy/docs/suitabilities.rst b/toolkit/components/normandy/docs/suitabilities.rst index 9ca4fa1a7b17..b199fc293890 100644 --- a/toolkit/components/normandy/docs/suitabilities.rst +++ b/toolkit/components/normandy/docs/suitabilities.rst @@ -71,4 +71,3 @@ The arguments of the recipe do not match the expected schema for the named action. This should be considered a permanent error, since the arguments are generally validated by the server. This likely represents an unrecogonized compatibility error. - diff --git a/toolkit/components/pictureinpicture/docs/index.rst b/toolkit/components/pictureinpicture/docs/index.rst index 324894c0d1e3..0a6a82483233 100644 --- a/toolkit/components/pictureinpicture/docs/index.rst +++ b/toolkit/components/pictureinpicture/docs/index.rst @@ -196,4 +196,3 @@ API References picture-in-picture-api player-api - diff --git a/toolkit/components/pictureinpicture/docs/picture-in-picture-api.rst b/toolkit/components/pictureinpicture/docs/picture-in-picture-api.rst index ce46875ef026..06f2ea5fc44e 100644 --- a/toolkit/components/pictureinpicture/docs/picture-in-picture-api.rst +++ b/toolkit/components/pictureinpicture/docs/picture-in-picture-api.rst @@ -1,4 +1,4 @@ -PictureInPicture Reference -=========================== -.. js:autoclass:: PictureInPicture - :members: +PictureInPicture Reference +=========================== +.. js:autoclass:: PictureInPicture + :members: diff --git a/toolkit/components/pictureinpicture/docs/player-api.rst b/toolkit/components/pictureinpicture/docs/player-api.rst index 8e7abf574b8d..a990967dc1a3 100644 --- a/toolkit/components/pictureinpicture/docs/player-api.rst +++ b/toolkit/components/pictureinpicture/docs/player-api.rst @@ -1,4 +1,4 @@ -Player Reference -====================== -.. js:autoclass:: Player - :members: \ No newline at end of file +Player Reference +====================== +.. js:autoclass:: Player + :members: diff --git a/toolkit/components/prompts/docs/index.rst b/toolkit/components/prompts/docs/index.rst index 4d2792fec31f..c518bef41bb2 100644 --- a/toolkit/components/prompts/docs/index.rst +++ b/toolkit/components/prompts/docs/index.rst @@ -7,4 +7,4 @@ Prompts nsIPromptService nsIPromptService-reference - modalTypes \ No newline at end of file + modalTypes diff --git a/toolkit/components/prompts/docs/nsIPromptService.rst b/toolkit/components/prompts/docs/nsIPromptService.rst index a39ef73f1992..8b9d920e2342 100644 --- a/toolkit/components/prompts/docs/nsIPromptService.rst +++ b/toolkit/components/prompts/docs/nsIPromptService.rst @@ -192,4 +192,4 @@ Then, in your promise handler callback function: For a full list of prompt methods check -`nsIPromptService reference `_. \ No newline at end of file +`nsIPromptService reference `_. diff --git a/toolkit/components/telemetry/docs/data/default-browser-ping.rst b/toolkit/components/telemetry/docs/data/default-browser-ping.rst index f1ef25831596..bdcc6d69960c 100644 --- a/toolkit/components/telemetry/docs/data/default-browser-ping.rst +++ b/toolkit/components/telemetry/docs/data/default-browser-ping.rst @@ -4,7 +4,7 @@ This opt-out ping is sent from the Default Browser Agent, which is a Windows-only program that registers itself during Firefox installation with the Windows scheduled tasks system so that it runs automatically every 24 hours, whether Firefox is running or not. The scheduled task gathers the data for this ping and then sends it by handing it off to :doc:`../internals/pingsender`. -Even though this ping is generated by a binary separate from Firefox itself, opting out of telemetry does disable it; the pref value is copied to the registry so that the default browser agent can read it without needing to work with profiles. Relevant policies are consulted as well. The agent also has its own pref, ``default-agent.enabled``, which if set to false disables all agent functionality, including generating this ping. +Even though this ping is generated by a binary separate from Firefox itself, opting out of telemetry does disable it; the pref value is copied to the registry so that the default browser agent can read it without needing to work with profiles. Relevant policies are consulted as well. The agent also has its own pref, ``default-agent.enabled``, which if set to false disables all agent functionality, including generating this ping. Each installation of Firefox has its own copy of the agent and its own scheduled task, so one ping will be sent every day for each installation on a given machine. This is needed because the default browser setting is per-user, and different installations may have been created by different users. If multiple operating system-level users are all using one copy of Firefox, only one scheduled task will have been created and only one ping will be sent, even though the users might have different default browser settings. diff --git a/toolkit/components/telemetry/docs/data/environment.rst b/toolkit/components/telemetry/docs/data/environment.rst index d6e088f96f60..3efa743e4d4a 100644 --- a/toolkit/components/telemetry/docs/data/environment.rst +++ b/toolkit/components/telemetry/docs/data/environment.rst @@ -427,7 +427,7 @@ This object contains data about the state of Firefox's sandbox. Specific keys are: - ``effectiveContentProcessLevel``: The meanings of the values are OS dependent. Details of the meanings can be found in the `Firefox prefs file `_. The value here is the effective value, not the raw value, some platforms enforce a minimum sandbox level. If there is an error calculating this, it will be ``null``. -- ``contentWin32kLockdownState``: The status of Win32k Lockdown for Content process. +- ``contentWin32kLockdownState``: The status of Win32k Lockdown for Content process. - LockdownEnabled = 1 - After Firefox 98, this value will no longer appear in Telemetry. - MissingWebRender = 2 diff --git a/toolkit/components/telemetry/docs/data/heartbeat-ping.rst b/toolkit/components/telemetry/docs/data/heartbeat-ping.rst index 413da0376d80..f1920111fd97 100644 --- a/toolkit/components/telemetry/docs/data/heartbeat-ping.rst +++ b/toolkit/components/telemetry/docs/data/heartbeat-ping.rst @@ -60,4 +60,3 @@ Notes: * The self-support page cannot include additional data in this payload. Only the the 4 flowId/surveyId/surveyVersion/testing fields are under the self-support page's control. See also: :doc:`common ping fields ` - diff --git a/toolkit/components/telemetry/docs/data/install-ping.rst b/toolkit/components/telemetry/docs/data/install-ping.rst index 15e5e742bc00..32bde280b51e 100644 --- a/toolkit/components/telemetry/docs/data/install-ping.rst +++ b/toolkit/components/telemetry/docs/data/install-ping.rst @@ -49,7 +49,7 @@ update_channel (both) version, build_id (both) Version number and Build ID of the installed product, from ``application.ini``. This is **not** the version of the installer itself. - + stub: 0 if the installation failed full: ``""`` if not found [#versionfailure]_ @@ -62,9 +62,9 @@ from_msi (full) _64bit_build (both) True if a 64-bit build was selected for installation. - + stub: This means the OS is 64-bit, the RAM requirement was met, and no third-party software that blocks 64-bit installations was found - + full: Hardcoded based on the architecture to be installed _64bit_os (both) @@ -94,17 +94,17 @@ set_default (both) new_default (both) True if the new installation is now the default browser (registered to handle the http protocol). - + full: Checks the association using ``AppAssocReg::QueryCurrentDefault`` and :abbr:`HKCU (HKEY_CURRENT_USER)`. stub: [DEPRECATED] [#stubnewdefault]_ old_default (both) True if firefox.exe in a different directory is now the default browser, mutually exclusive with new_default. The details are the same as new_default. - + had_old_install (both) True if at least one existing installation of Firefox was found on the system prior to this installation. - + full: Checks for the installation directory given in the ``Software\Mozilla\${BrandFullName}`` registry keys, either :abbr:`HKLM` or :abbr:`HKCU` stub: Checks for the top level profile directory ``%LOCALAPPDATA%\Mozilla\Firefox`` @@ -229,6 +229,6 @@ Footnotes .. [#stubsetdefault] We no longer attempt to change the default browser setting in the streamlined stub, so set_default should always be false. -.. [#stubnewdefault] We no longer attempt to change the default browser setting in the streamlined stub, so new_default should usually be false, but the stub still checks the association at ``Software\Classes\http\shell\open\command`` in :abbr:`HKLM` or :abbr:`HKCU`. +.. [#stubnewdefault] We no longer attempt to change the default browser setting in the streamlined stub, so new_default should usually be false, but the stub still checks the association at ``Software\Classes\http\shell\open\command`` in :abbr:`HKLM` or :abbr:`HKCU`. .. [#downloadphase] ``download_time`` was previously called ``download_phase_time``, this includes retries during the download phase. There was a different ``download_time`` field that specifically measured only the time of the last download, this is still submitted but it is ignored during ingestion. diff --git a/toolkit/components/telemetry/docs/data/main-ping.rst b/toolkit/components/telemetry/docs/data/main-ping.rst index 47355efcc97a..23f7d8c600c4 100644 --- a/toolkit/components/telemetry/docs/data/main-ping.rst +++ b/toolkit/components/telemetry/docs/data/main-ping.rst @@ -502,4 +502,3 @@ Version History - Firefox 80: - Stopped reporting ``GCTelemetry`` (`bug 1482089 `_). - diff --git a/toolkit/components/telemetry/docs/data/uitour-ping.rst b/toolkit/components/telemetry/docs/data/uitour-ping.rst index 3d5e5dec6d35..06e4a9f49bbb 100644 --- a/toolkit/components/telemetry/docs/data/uitour-ping.rst +++ b/toolkit/components/telemetry/docs/data/uitour-ping.rst @@ -23,4 +23,3 @@ Structure: } See also: :doc:`common ping fields ` - diff --git a/toolkit/components/telemetry/docs/data/update-ping.rst b/toolkit/components/telemetry/docs/data/update-ping.rst index 68180d640524..037d52101933 100644 --- a/toolkit/components/telemetry/docs/data/update-ping.rst +++ b/toolkit/components/telemetry/docs/data/update-ping.rst @@ -76,4 +76,4 @@ The following is a list of conditions and expected behaviours for the ``update`` - **If the build update channel contains the CCK keyword**, the update ping will not report it but rather report a vanilla channel name (e.g. ``mozilla-cck-test-beta`` gets reported as ``beta``). - **If a profile refresh occurs before the update is applied**, the update ping with ``reason = success`` will not be generated. - **If the update is applied on a new profile, different then the one it was downloaded in**, the update ping with ``reason = success`` will not be generated. -- **If a newer browser version is installed over an older**, the update ping with ``reason = success`` will not be generated. \ No newline at end of file +- **If a newer browser version is installed over an older**, the update ping with ``reason = success`` will not be generated. diff --git a/toolkit/components/telemetry/docs/internals/tests.rst b/toolkit/components/telemetry/docs/internals/tests.rst index 7dd91482a7d8..062809ce39e1 100644 --- a/toolkit/components/telemetry/docs/internals/tests.rst +++ b/toolkit/components/telemetry/docs/internals/tests.rst @@ -97,4 +97,3 @@ module to make their lives easier. This can be used for tests like “If five bookmarks are read from the database, does the bookmark count Histogram have a value of 5 in it?”. - diff --git a/toolkit/components/telemetry/docs/obsolete/activation-ping.rst b/toolkit/components/telemetry/docs/obsolete/activation-ping.rst index 063dea8d6d4c..a2c241aec4bf 100644 --- a/toolkit/components/telemetry/docs/obsolete/activation-ping.rst +++ b/toolkit/components/telemetry/docs/obsolete/activation-ping.rst @@ -67,4 +67,3 @@ On Android, the uploader has a high probability of delivering the complete data for a given client but not a 100% probability. This was a conscious decision to keep the code simple. Even if we drop a ping, it will be resent on future startups until we have confirmation that it has been uploaded. - diff --git a/toolkit/crashreporter/docs/Using_the_Mozilla_symbol_server.rst b/toolkit/crashreporter/docs/Using_the_Mozilla_symbol_server.rst index bc5f2391e831..3f6dc1164541 100644 --- a/toolkit/crashreporter/docs/Using_the_Mozilla_symbol_server.rst +++ b/toolkit/crashreporter/docs/Using_the_Mozilla_symbol_server.rst @@ -166,4 +166,3 @@ Internet Explorer to ensure "Work Offline" is unchecked. :class: internal .. |The WinDbg Symbol Search Path dialog with the Mozilla symbol server configured| image:: img/snip_20170901081816.png :class: internal - diff --git a/toolkit/modules/subprocess/docs/index.rst b/toolkit/modules/subprocess/docs/index.rst index 2e0511440fca..983fe30d4d6a 100644 --- a/toolkit/modules/subprocess/docs/index.rst +++ b/toolkit/modules/subprocess/docs/index.rst @@ -224,4 +224,3 @@ addition: } assert(output.includes("FOO=BAR\n")); - diff --git a/tools/fuzzing/docs/fuzzing_interface.rst b/tools/fuzzing/docs/fuzzing_interface.rst index ebf553b1897f..4ce39bede43f 100644 --- a/tools/fuzzing/docs/fuzzing_interface.rst +++ b/tools/fuzzing/docs/fuzzing_interface.rst @@ -75,7 +75,7 @@ which you can download using In both commands, ``firefox-fuzzing`` indicates the name of the directory that will be created for the download. -Afterwards, you can reproduce the bug using +Afterwards, you can reproduce the bug using :: @@ -195,7 +195,7 @@ In order to define your fuzzing target ``MyTarget``, you only need to implement At startup, the fuzzing interface calls this function **once**, so this can be used to perform one-time operations like initializing subsystems or parsing extra fuzzing options. - + This function is the equivalent of the `LLVMFuzzerInitialize `__ function and has the same signature. However, with our fuzzing interface, it won't be resolved by its name, so it can be defined ``static`` and called diff --git a/tools/fuzzing/docs/index.rst b/tools/fuzzing/docs/index.rst index ae39b95e06fb..9a4e2d01c43d 100644 --- a/tools/fuzzing/docs/index.rst +++ b/tools/fuzzing/docs/index.rst @@ -398,7 +398,7 @@ some cases block the fuzzer all together. Some examples are: corrupt logs/debugger output or provide a broken/invalid crash report. - Broken builds - This is fairly straightforward, without up-to-date builds - fuzzers are unable to run or verify fixes. + fuzzers are unable to run or verify fixes. - Missing instrumentation - In some cases tools such as ASan are used as defect oracles and are required by the fuzzing tools to allow for proper @@ -410,7 +410,7 @@ some cases block the fuzzer all together. Some examples are: Since these types of crashes harm the overall fuzzing progress, it is important for them to be addressed in a timely manner. Even if the bug itself might seem trivial and low priority for the product, it can still have devastating effects -on fuzzing and hence prevent finding other critical issues. +on fuzzing and hence prevent finding other critical issues. Issues in Bugzilla are marked as fuzz blockers by adding “[fuzzblocker]” to the “Whiteboard” field. A list of open issues marked as fuzz blockers diff --git a/tools/moztreedocs/docs/run-try-job.rst b/tools/moztreedocs/docs/run-try-job.rst index 0f2425c87cad..5651e4998faa 100644 --- a/tools/moztreedocs/docs/run-try-job.rst +++ b/tools/moztreedocs/docs/run-try-job.rst @@ -10,13 +10,13 @@ Documentation has two try jobs associated : mach try fuzzy -q "'doc-generate" - ``doc-upload`` - This uploads documentation to `gecko-l1 bucket `__ with the committed changes. - + .. code-block:: shell mach try fuzzy -q "'doc-upload" .. important:: - + Running try jobs require the user to have try server access. .. note:: diff --git a/tools/tryselect/docs/index.rst b/tools/tryselect/docs/index.rst index 39dc76cfa6d9..673b93a233e0 100644 --- a/tools/tryselect/docs/index.rst +++ b/tools/tryselect/docs/index.rst @@ -69,4 +69,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/tools/tryselect/docs/selectors/empty.rst b/tools/tryselect/docs/selectors/empty.rst index 4eb6a03fd87d..c3ea61b9cea5 100644 --- a/tools/tryselect/docs/selectors/empty.rst +++ b/tools/tryselect/docs/selectors/empty.rst @@ -19,4 +19,3 @@ To do this: 2. Select ``Add new jobs`` (it may take a couple seconds to load). 3. Choose your desired tasks by clicking them one at a time. 4. At the top of your commit, select ``Trigger New Jobs``. - diff --git a/xpcom/docs/index.rst b/xpcom/docs/index.rst index fdac201b0fa8..19d261fce3fe 100644 --- a/xpcom/docs/index.rst +++ b/xpcom/docs/index.rst @@ -13,4 +13,3 @@ These pages contain documentation for Mozilla's Cross-Platform Component Object collections xpidl dmd - diff --git a/xpcom/docs/logging.rst b/xpcom/docs/logging.rst index 7d32640b72b0..e96e7781023a 100644 --- a/xpcom/docs/logging.rst +++ b/xpcom/docs/logging.rst @@ -199,4 +199,3 @@ The `log` crate lists the available `log levels `_ docs for more details on logging options. - diff --git a/xpcom/docs/refptr.rst b/xpcom/docs/refptr.rst index 134ea3df252f..f4e8f813757a 100644 --- a/xpcom/docs/refptr.rst +++ b/xpcom/docs/refptr.rst @@ -79,9 +79,3 @@ smart pointer with ``nullptr`` if either of these steps fail. In contrast ``do_GetWeakReference`` does the opposite, using ``QueryInterface`` to cast the type to ``nsISupportsWeakReference*``, and acquire a ``nsIWeakReference*`` to the passed-in object. - - - - - - diff --git a/xpcom/docs/stringguide.rst b/xpcom/docs/stringguide.rst index e3abde948492..98272ae07e64 100644 --- a/xpcom/docs/stringguide.rst +++ b/xpcom/docs/stringguide.rst @@ -459,7 +459,7 @@ common encodings are: used for interchange. In addition, there exist multiple other (legacy) encodings. The Web-relevant -ones are defined in the `Encoding Standard `_. +ones are defined in the `Encoding Standard `_. Conversions from these encodings to UTF-8 and UTF-16 are provided by `mozilla::Encoding `_.