Bug 1444628 - Fix a bunch of typo in the doc r?ahal draft
authorSylvestre Ledru <sledru@mozilla.com>
Sat, 10 Mar 2018 17:14:38 +0100
changeset 765897 b54c375e96ac2b570f607f39cb500792695f4a88
parent 763675 3fc217d09a458b50066156d29948a151aa53a41b
push id102175
push usersledru@mozilla.com
push dateSat, 10 Mar 2018 16:15:11 +0000
reviewersahal
bugs1444628
milestone60.0a1
Bug 1444628 - Fix a bunch of typo in the doc r?ahal MozReview-Commit-ID: SNXsViVUm0
browser/base/content/docs/tabbrowser/async-tab-switcher.rst
build/docs/build-overview.rst
build/docs/locales.rst
build/docs/python.rst
mobile/android/docs/push.rst
taskcluster/docs/how-tos.rst
testing/mozbase/docs/mozprocess.rst
testing/mozharness/external_tools/virtualenv/docs/changes.rst
testing/web-platform/tests/tools/six/documentation/index.rst
testing/web-platform/tests/tools/wptrunner/README.rst
testing/web-platform/tests/tools/wptserve/docs/stash.rst
toolkit/components/normandy/docs/data-collection.rst
toolkit/components/telemetry/docs/data/core-ping.rst
toolkit/components/telemetry/docs/data/main-ping.rst
toolkit/components/telemetry/docs/data/sync-ping.rst
toolkit/components/telemetry/docs/fhr/dataformat.rst
--- a/browser/base/content/docs/tabbrowser/async-tab-switcher.rst
+++ b/browser/base/content/docs/tabbrowser/async-tab-switcher.rst
@@ -28,17 +28,17 @@ renderLayers, hasLayers, docShellIsActiv
   For non-remote ``<xul:browser>``'s, ``renderLayers`` is an alias for ``docShellIsActive``.
 
 ``hasLayers``
   For remote ``<xul:browser>``'s, this read-only property returns ``true`` if the compositor has layers for this tab, and ``false`` otherwise.
 
   For non-remote ``<xul:browser>``'s, ``hasLayers`` returns the value for ``docShellIsActive``.
 
 ``docShellIsActive``
-  For remote ``<xul:browser>``'s, setting ``docShellIsActive`` to ``true`` also sets ``renderLayers`` to true, and then sends a message to the content process to set its top-level docShell active state to ``true``. Similarly, setting ``docShellIsActive`` to ``false`` also sets ``renderLayers`` to false, and then sends a message ot the content process to set its top-level docShell active state to ``false``.
+  For remote ``<xul:browser>``'s, setting ``docShellIsActive`` to ``true`` also sets ``renderLayers`` to true, and then sends a message to the content process to set its top-level docShell active state to ``true``. Similarly, setting ``docShellIsActive`` to ``false`` also sets ``renderLayers`` to false, and then sends a message to the content process to set its top-level docShell active state to ``false``.
 
   For non-remote ``<xul:browser>``'s, ``docShellIsActive`` forwards to the ``isActive`` property on the ``<xul:browser>``'s top-level docShell.
 
   Setting a docShell to be active causes the tab's visibilitychange event to fire to indicate that the tab has become visible. Media that was waiting to be played until the tab is selected will also begin to play.
 
   An active docShell is also required in order to generate a print preview of the loaded document.
 
 
@@ -225,9 +225,9 @@ Warming is controlled by the following p
 
 .. _async-tab-switcher.logging:
 
 Logging
 =======
 
 The async tab switcher has some logging capabilities that make it easier to debug and reason about its behaviour. Setting the hidden ``browser.tabs.remote.logSwitchTiming`` pref to true will put logging into the Browser Console.
 
-Alternatively, setting the ``useDumpForLogging`` property to true within the source code of the tab switcher will dump those logs to stdout.
\ No newline at end of file
+Alternatively, setting the ``useDumpForLogging`` property to true within the source code of the tab switcher will dump those logs to stdout.
--- a/build/docs/build-overview.rst
+++ b/build/docs/build-overview.rst
@@ -98,17 +98,17 @@ build backend which then determined it h
 from those data structures. Most of them already existed and didn't need
 changed. However, *1* was updated as a result of the new configuration.
 The whole process took *5.03s*. Although, only *3.79s* was in
 CPU time. That likely means we spent roughly *25%* of the time waiting on
 I/O.
 
 For more on how ``moz.build`` files work, see :ref:`mozbuild-files`.
 
-Phase 3: Invokation of the Build Backend
+Phase 3: Invocation of the Build Backend
 ========================================
 
 When most people think of the build system, they think of phase 3. This is
 where we take all the code in the tree and produce Firefox or whatever
 application you are creating. Phase 3 effectively takes whatever was
 generated by phase 2 and runs it. Since the dawn of Mozilla, this has been
 make consuming Makefiles. However, with the transition to moz.build files,
 you may soon see non-Make build backends, such as Tup or Visual Studio.
--- a/build/docs/locales.rst
+++ b/build/docs/locales.rst
@@ -46,17 +46,17 @@ can point to the directory via
 
    .. code-block:: shell
 
       ac_add_options --with-l10n-base=/make/this/a/absolute/path
 
 Instructions for multi-locale builds
 ------------------------------------
 
-If you want to create a single build with mutliple locales, you will do
+If you want to create a single build with multiple locales, you will do
 
 #. Create a build and package
 
    .. code-block:: shell
 
       ./mach build
       ./mach package
 
--- a/build/docs/python.rst
+++ b/build/docs/python.rst
@@ -102,17 +102,17 @@ the build system.
   We rely heavily on ``.pth`` files in our virtualenv. A ``.pth`` file
   is a special file that contains a list of paths. Python will take the
   set of listed paths encountered in ``.pth`` files and add them to
   ``sys.path``.
 
   When Python compiles a ``.py`` file to bytecode, it writes out a
   ``.pyc`` file so it doesn't have to perform this compilation again.
   It puts these ``.pyc`` files alongside the ``.pyc`` file. Python
-  provides very little control for determing where these ``.pyc`` files
+  provides very little control for determining where these ``.pyc`` files
   go, even in Python 3 (which offers customer importers).
 
   With ``.pth`` files pointing back to directories in the source tree
   and not the object directory, ``.pyc`` files are created in the source
   tree. This is bad because when Python imports a module, it first looks
   for a ``.pyc`` file before the ``.py`` file. If there is a ``.pyc``
   file but no ``.py`` file, it will happily import the module. This
   wreaks havoc during file moves, refactoring, etc.
--- a/mobile/android/docs/push.rst
+++ b/mobile/android/docs/push.rst
@@ -117,17 +117,17 @@ includes:
 
 The `PushManager` uses the `PushSubscription` service and profile maintained in
 the `PushManagerStorage` to determine how to deliver incoming GCM push messages.
 
 Each `PushRegistration` corresponds to a unique *uaid* (User-Agent ID) on the
 autopush server.  Each *uaid* is long-lived; a healthy client will maintain the
 same *uaid* until the client's configuration changes or the service expires the
 registration due to inactivity or an unexpected server event.  Each
-`PushSubscription` is associated to a given *uaid* and correponds to a unique
+`PushSubscription` is associated to a given *uaid* and corresponds to a unique
 (per-*uaid*) *chid* (Channel ID) on the autopush server.  An individual *chid*
 is potentially long-lived, but clients must expect the service to expire *chid*s
 as part of regular maintenance.  The `PushManager` uses an `AutopushClient`
 instance to interact with the autopush server.
 
 Between the `PushManager`, the `PushManagerStorage`, and assorted GCM event
 broadcast receivers, push messages that do not target Gecko can be implemented.
 
--- a/taskcluster/docs/how-tos.rst
+++ b/taskcluster/docs/how-tos.rst
@@ -137,17 +137,17 @@ options.  A few questions to consider:
  * Is this a new build platform or variant that will produce an artifact to
    be run through the usual test suites?
 
  * Does this task depend on other tasks?  Do other tasks depend on it?
 
  * Is this one of a few related tasks, or will you need to generate a large
    set of tasks using some programmatic means (for example, chunking)?
 
- * How is the task actually excuted?  Mozharness?  Mach?
+ * How is the task actually executed?  Mozharness?  Mach?
 
  * What kind of environment does the task require?
 
 Armed with that information, you can choose among a few options for
 implementing this new task.  Try to choose the simplest solution that will
 satisfy your near-term needs.  Since this is all implemented in-tree, it
 is not difficult to refactor later when you need more generality.
 
--- a/testing/mozbase/docs/mozprocess.rst
+++ b/testing/mozbase/docs/mozprocess.rst
@@ -13,17 +13,17 @@ features beyond those available with pyt
   and normal process termination
 
 Running a process
 -----------------
 
 mozprocess consists of two classes: ProcessHandler inherits from ProcessHandlerMixin.
 
 Let's see how to run a process.
-First, the class should be instanciated with at least one argument which is a command (or a list formed by the command followed by its arguments).
+First, the class should be instantiated with at least one argument which is a command (or a list formed by the command followed by its arguments).
 Then the process can be launched using the *run()* method.
 Finally the *wait()* method will wait until end of execution.
 
 .. code-block:: python
 
     from mozprocess import processhandler
 
     # under Windows replace by command = ['dir', '/a']
@@ -202,17 +202,17 @@ Except on Windows, you can specify the s
     p = processhandler.ProcessHandler(command)
     p.run()
     time.sleep(2)
     p.kill()
 
 End of execution
 ````````````````
 
-You can provide a function or a list of functions to call at the end of the process using the initilization parameter *onFinish*.
+You can provide a function or a list of functions to call at the end of the process using the initialization parameter *onFinish*.
 
 .. code-block:: python
 
     from mozprocess import processhandler
 
     def finish():
         print("Finished!!")
 
@@ -292,17 +292,17 @@ By default the *ignore_children* option 
 
     command = './proc_parent.sh'
     p = processhandler.ProcessHandler(command, ignore_children=False, onFinish=finish)
     p.run()
     time.sleep(2)
     print("kill")
     p.kill()
 
-If *ignore_children* is set to *True*, killing will apply only to the main process that will wait children end of execution before stoping (join).
+If *ignore_children* is set to *True*, killing will apply only to the main process that will wait children end of execution before stopping (join).
 
 .. code-block:: python
 
     import time
     from mozprocess import processhandler
 
     def finish():
         print("Finished")
--- a/testing/mozharness/external_tools/virtualenv/docs/changes.rst
+++ b/testing/mozharness/external_tools/virtualenv/docs/changes.rst
@@ -58,17 +58,17 @@ 14.0.3 (2016-01-28)
 * Upgrade setuptools to 19.6.1
 
 
 14.0.2 (2016-01-28)
 -------------------
 
 * Upgrade setuptools to 19.6
 
-* Supress any errors from `unset` on different shells (:pull:`843`)
+* Suppress any errors from `unset` on different shells (:pull:`843`)
 
 * Normalize letter case for prefix path checking. Fixes :issue:`837`
 
 
 14.0.1 (2016-01-21)
 -------------------
 
 * Upgrade from pip 8.0.0 to 8.0.2.
@@ -350,17 +350,17 @@ 1.10 (2013-07-23)
 * Fixed issue with readline on Windows.
 
 .. _Distribute: https://pypi.python.org/pypi/distribute
 
 1.9.1 (2013-03-08)
 ------------------
 
 * Updated to pip 1.3.1 that fixed a major backward incompatible change of
-  parsing URLs to externally hosted packages that got accidentily included
+  parsing URLs to externally hosted packages that got accidentally included
   in pip 1.3.
 
 1.9 (2013-03-07)
 ----------------
 
 * Unset VIRTUAL_ENV environment variable in deactivate.bat (Pull #364)
 * Upgraded distribute to 0.6.34.
 * Added ``--no-setuptools`` and ``--no-pip`` options (Pull #336).
--- a/testing/web-platform/tests/tools/six/documentation/index.rst
+++ b/testing/web-platform/tests/tools/six/documentation/index.rst
@@ -99,17 +99,17 @@ Here's example usage of the module::
            handle_class(value)
        elif isinstance(value, six.string_types):
            handle_string(value)
 
 
 Object model compatibility
 >>>>>>>>>>>>>>>>>>>>>>>>>>
 
-Python 3 renamed the attributes of several intepreter data structures.  The
+Python 3 renamed the attributes of several interpreter data structures.  The
 following accessors are available.  Note that the recommended way to inspect
 functions and methods is the stdlib :mod:`py3:inspect` module.
 
 
 .. function:: get_unbound_function(meth)
 
    Get the function out of unbound method *meth*.  In Python 3, unbound methods
    don't exist, so this function just returns *meth* unchanged.  Example
@@ -454,17 +454,17 @@ Similarly, to get the function to reload
 builtin module to the ``imp`` module, use::
 
    from six.moves import reload_module
 
 For the most part, :mod:`six.moves` aliases are the names of the modules in
 Python 3.  When the new Python 3 name is a package, the components of the name
 are separated by underscores.  For example, ``html.parser`` becomes
 ``html_parser``.  In some cases where several modules have been combined, the
-Python 2 name is retained.  This is so the appropiate modules can be found when
+Python 2 name is retained.  This is so the appropriate modules can be found when
 running on Python 2.  For example, ``BaseHTTPServer`` which is in
 ``http.server`` in Python 3 is aliased as ``BaseHTTPServer``.
 
 Some modules which had two implementations have been merged in Python 3.  For
 example, ``cPickle`` no longer exists in Python 3; it was merged with
 ``pickle``.  In these cases, fetching the fast version will load the fast one on
 Python 2 and the merged module in Python 3.
 
--- a/testing/web-platform/tests/tools/wptrunner/README.rst
+++ b/testing/web-platform/tests/tools/wptrunner/README.rst
@@ -174,17 +174,17 @@ In a test expectation file, each resourc
 single section, with the section heading being the part after the last
 `/` in the test url. Tests that have subsections may have subsections
 for those subtests in which the heading is the name of the subtest.
 
 Simple key-value pairs are of the form::
 
   key: value
 
-Note that unlike ini files, only `:` is a valid seperator; `=` will
+Note that unlike ini files, only `:` is a valid separator; `=` will
 not work as expected. Key-value pairs may also have conditional
 values of the form::
 
   key:
     if condition1: value1
     if condition2: value2
     default
 
--- a/testing/web-platform/tests/tools/wptserve/docs/stash.rst
+++ b/testing/web-platform/tests/tools/wptserve/docs/stash.rst
@@ -1,14 +1,14 @@
 Stash
 =====
 
 Object for storing cross-request state. This is unusual in that keys
 must be UUIDs, in order to prevent different clients setting the same
-key, and values are write-once, read-once to minimise the chances of
+key, and values are write-once, read-once to minimize the chances of
 state persisting indefinitely. The stash defines two operations;
 `put`, to add state and `take` to remove state. Furthermore, the view
 of the stash is path-specific; by default a request will only see the
 part of the stash corresponding to its own path.
 
 A typical example of using a stash to store state might be::
 
   @handler
--- a/toolkit/components/normandy/docs/data-collection.rst
+++ b/toolkit/components/normandy/docs/data-collection.rst
@@ -102,17 +102,17 @@ Enrollment
       The name of the study (``recipe.arguments.slug``).
    extra
       branch
          The name of the branch the user was assigned to (example:
          ``"control"`` or ``"experiment"``).
       experimentType
          The type of preference experiment. Currently this can take
          values "exp" and "exp-highpop", the latter being for
-         experiments targetting large numbers of users.
+         experiments targeting large numbers of users.
 
 Unenrollment
    method
       The string ``"unenroll"``.
    object
       The string ``"preference_study"``.
    value
       The name of the study (``recipe.arguments.slug``).
--- a/toolkit/components/telemetry/docs/data/core-ping.rst
+++ b/toolkit/components/telemetry/docs/data/core-ping.rst
@@ -117,17 +117,17 @@ sessions & durations
 ~~~~~~~~~~~~~~~~~~~~
 On Android, a session is the time when Firefox is focused in the foreground.
 `sessions` tracks the number of sessions since the last upload and
 `durations` is the accumulated duration in seconds of all of these
 sessions. Note that showing a dialog (including a Firefox dialog) will
 take Firefox out of focus & end the current session.
 
 An implementation that records a session when Firefox is completely hidden is
-preferrable (e.g. to avoid the dialog issue above), however, it's more complex
+preferable (e.g. to avoid the dialog issue above), however, it's more complex
 to implement and so we chose not to, at least for the initial implementation.
 
 profileDate
 ~~~~~~~~~~~
 On Android, this value is created at profile creation time and retrieved or,
 for legacy profiles, taken from the package install time (note: this is not the
 same exact metric as profile creation time but we compromised in favor of ease
 of implementation).
--- a/toolkit/components/telemetry/docs/data/main-ping.rst
+++ b/toolkit/components/telemetry/docs/data/main-ping.rst
@@ -640,17 +640,17 @@ Structure:
     }
 
 UITelemetry
 -----------
 See the ``UITelemetry data format`` documentation.
 
 slowSQL
 -------
-This section contains the informations about the slow SQL queries for both the main and other threads. The execution of an SQL statement is considered slow if it takes 50ms or more on the main thread or 100ms or more on other threads. Slow SQL statements will be automatically trimmed to 1000 characters. This limit doesn't include the ellipsis and database name, that are appended at the end of the stored statement.
+This section contains the information about the slow SQL queries for both the main and other threads. The execution of an SQL statement is considered slow if it takes 50ms or more on the main thread or 100ms or more on other threads. Slow SQL statements will be automatically trimmed to 1000 characters. This limit doesn't include the ellipsis and database name, that are appended at the end of the stored statement.
 
 Structure:
 
 .. code-block:: js
 
     "slowSQL": {
       "mainThread": {
         "Sanitized SQL Statement": [
--- a/toolkit/components/telemetry/docs/data/sync-ping.rst
+++ b/toolkit/components/telemetry/docs/data/sync-ping.rst
@@ -117,17 +117,17 @@ The ping may only contain a certain numb
 syncs.took
 ~~~~~~~~~~
 
 These values should be monotonic. If we can't get a monotonic timestamp, -1 will be reported on the payload, and the values will be omitted from the engines. Additionally, the value will be omitted from an engine if it would be 0 (either due to timer inaccuracy or finishing instantaneously).
 
 uid
 ~~~~~~~~~
 
-This property containing a hash of the FxA account identifier, which is a 32 character hexidecimal string. In the case that we are unable to authenticate with FxA and have never authenticated in the past, it will be a placeholder string consisting of 32 repeated ``0`` characters.
+This property containing a hash of the FxA account identifier, which is a 32 character hexadecimal string. In the case that we are unable to authenticate with FxA and have never authenticated in the past, it will be a placeholder string consisting of 32 repeated ``0`` characters.
 
 syncs.why
 ~~~~~~~~~
 
 One of the following values:
 
 - ``startup``: This is the first sync triggered after browser startup.
 - ``schedule``: This is a sync triggered because it has been too long since the last sync.
--- a/toolkit/components/telemetry/docs/fhr/dataformat.rst
+++ b/toolkit/components/telemetry/docs/fhr/dataformat.rst
@@ -744,17 +744,17 @@ properties are:
 
 extension
     Integer count of installed extensions.
 plugin
     Integer count of installed plugins.
 theme
     Integer count of installed themes.
 lwtheme
-    Integer count of installed lightweigh themes.
+    Integer count of installed lightweight themes.
 
 Notes
 ^^^^^
 
 Add-ons opted out of AMO updates are included in the counts. This differs from
 the behavior of the active add-ons measurement.
 
 If no add-ons of a particular type are installed, the property for that type