Merge branch 'rdale/spelling' into 'master'

Fix spelling of it's and its

See merge request BuildStream/buildstream!877

34 files changed, 51 insertions, 51 deletions

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 959f5894f..0f872e9e1 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -120,7 +120,7 @@ preferred in separate commits.
 
 If a commit in your branch modifies behavior such that a test must also
 be changed to match the new behavior, then the tests should be updated
-with the same commit, so that every commit passes it's own tests.
+with the same commit, so that every commit passes its own tests.
 
 
 Commit messages
@@ -733,7 +733,7 @@ is **illegal** to override any other method.
 * Subclasses are not allowed to override any other methods.
 
 The key here is that in BuildStream, we consider it unacceptable
-that a subclass overrides a method of it's parent class unless
+that a subclass overrides a method of its parent class unless
 the said parent class has explicitly given permission to subclasses
 to do so, and outlined the API contract for this purpose. No surprises
 are allowed.
@@ -937,7 +937,7 @@ possible, and avoid any cyclic relationships in modules.
 
 For instance, the ``Source`` objects are owned by ``Element``
 objects in the BuildStream data model, and as such the ``Element``
-will delegate some activities to the ``Source`` objects in it's
+will delegate some activities to the ``Source`` objects in its
 possesion. The ``Source`` objects should however never call functions
 on the ``Element`` object, nor should the ``Source`` object itself
 have any understanding of what an ``Element`` is.
@@ -1180,7 +1180,7 @@ The BuildStream documentation style is as follows:
     Feel free to also use ``.. attention::`` or ``.. important::`` to call special
     attention to a paragraph, ``.. tip::`` to give the reader a special tip on how
     to use an advanced feature or ``.. warning::`` to warn the user about a potential
-    misuse of the API and explain it's consequences.
+    misuse of the API and explain its consequences.
 
 * Code blocks are defined using: ``.. code:: LANGUAGE`` blocks, followed by an empty
   line and then indented (3 spaces) text. Note that the default language is ``python``.
diff --git a/buildstream/_frontend/cli.py b/buildstream/_frontend/cli.py
index 20624e2ac..85632959f 100644
--- a/buildstream/_frontend/cli.py
+++ b/buildstream/_frontend/cli.py
@@ -104,7 +104,7 @@ def complete_target(args, incomplete):
     # The project is not required to have an element-path
     element_directory = project.get('element-path')
 
-    # If a project was loaded, use it's element-path to
+    # If a project was loaded, use its element-path to
     # adjust our completion's base directory
     if element_directory:
         base_directory = os.path.join(base_directory, element_directory)
diff --git a/buildstream/_fuse/mount.py b/buildstream/_fuse/mount.py
index 30cc85b77..83c98a97a 100644
--- a/buildstream/_fuse/mount.py
+++ b/buildstream/_fuse/mount.py
@@ -60,7 +60,7 @@ class FuseMountError(Exception):
 #
 #   With the daemon approach, we know that the fuse is mounted right
 #   away when fuse_main() returns, then the daemon will go and handle
-#   requests on it's own, but then we have no way to shut down the
+#   requests on its own, but then we have no way to shut down the
 #   daemon.
 #
 #   With the blocking approach, we still have it as a child process
@@ -105,7 +105,7 @@ class Mount():
         self.__process = Process(target=self.__run_fuse)
 
         # Ensure the child fork() does not inherit our signal handlers, if the
-        # child wants to handle a signal then it will first set it's own
+        # child wants to handle a signal then it will first set its own
         # handler, and then unblock it.
         with _signals.blocked([signal.SIGTERM, signal.SIGTSTP, signal.SIGINT], ignore=False):
             self.__process.start()
@@ -185,7 +185,7 @@ class Mount():
         self.__operations = self.create_operations()
 
         # Run fuse in foreground in this child process, internally libfuse
-        # will handle SIGTERM and gracefully exit it's own little main loop.
+        # will handle SIGTERM and gracefully exit its own little main loop.
         #
         FUSE(self.__operations, self.__mountpoint, nothreads=True, foreground=True, nonempty=True,
              **self._fuse_mount_options)
diff --git a/buildstream/element.py b/buildstream/element.py
index a77550f9d..1e6bf548c 100644
--- a/buildstream/element.py
+++ b/buildstream/element.py
@@ -867,8 +867,8 @@ class Element(Plugin):
 
     # _new_from_meta():
     #
-    # Recursively instantiate a new Element instance, it's sources
-    # and it's dependencies from a meta element.
+    # Recursively instantiate a new Element instance, its sources
+    # and its dependencies from a meta element.
     #
     # Args:
     #    artifacts (ArtifactCache): The artifact cache
@@ -1217,7 +1217,7 @@ class Element(Plugin):
     # _preflight():
     #
     # A wrapper for calling the abstract preflight() method on
-    # the element and it's sources.
+    # the element and its sources.
     #
     def _preflight(self):
 
@@ -1999,7 +1999,7 @@ class Element(Plugin):
         if workspace:
 
             # A workspace is considered inconsistent in the case
-            # that it's directory went missing
+            # that its directory went missing
             #
             fullpath = workspace.get_absolute_path()
             if not os.path.exists(fullpath):
diff --git a/buildstream/plugin.py b/buildstream/plugin.py
index d8cca2751..d01cbe112 100644
--- a/buildstream/plugin.py
+++ b/buildstream/plugin.py
@@ -169,7 +169,7 @@ class Plugin():
 
         For elements, this is the project relative bst filename,
         for sources this is the owning element's name with a suffix
-        indicating it's index on the owning element.
+        indicating its index on the owning element.
 
         For sources this is for display purposes only.
         """
@@ -208,8 +208,8 @@ class Plugin():
            node (dict): The loaded configuration dictionary
 
         Raises:
-           :class:`.SourceError`: If its a :class:`.Source` implementation
-           :class:`.ElementError`: If its an :class:`.Element` implementation
+           :class:`.SourceError`: If it's a :class:`.Source` implementation
+           :class:`.ElementError`: If it's an :class:`.Element` implementation
 
         Plugin implementors should implement this method to read configuration
         data and store it.
@@ -238,8 +238,8 @@ class Plugin():
         """Preflight Check
 
         Raises:
-           :class:`.SourceError`: If its a :class:`.Source` implementation
-           :class:`.ElementError`: If its an :class:`.Element` implementation
+           :class:`.SourceError`: If it's a :class:`.Source` implementation
+           :class:`.ElementError`: If it's an :class:`.Element` implementation
 
         This method is run after :func:`Plugin.configure() <buildstream.plugin.Plugin.configure>`
         and after the pipeline is fully constructed.
diff --git a/buildstream/plugins/elements/compose.py b/buildstream/plugins/elements/compose.py
index a206dd6d7..6b99947d5 100644
--- a/buildstream/plugins/elements/compose.py
+++ b/buildstream/plugins/elements/compose.py
@@ -41,7 +41,7 @@ from buildstream import Element, Scope
 class ComposeElement(Element):
     # pylint: disable=attribute-defined-outside-init
 
-    # The compose element's output is it's dependencies, so
+    # The compose element's output is its dependencies, so
     # we must rebuild if the dependencies change even when
     # not in strict build plans.
     #
diff --git a/buildstream/plugins/elements/filter.py b/buildstream/plugins/elements/filter.py
index 22fddd14f..672325304 100644
--- a/buildstream/plugins/elements/filter.py
+++ b/buildstream/plugins/elements/filter.py
@@ -47,7 +47,7 @@ from buildstream import Element, ElementError, Scope
 class FilterElement(Element):
     # pylint: disable=attribute-defined-outside-init
 
-    # The filter element's output is it's dependencies, so
+    # The filter element's output is its dependencies, so
     # we must rebuild if the dependencies change even when
     # not in strict build plans.
     BST_STRICT_REBUILD = True
diff --git a/buildstream/plugins/sources/deb.py b/buildstream/plugins/sources/deb.py
index 1cf8beb22..7c70e1de9 100644
--- a/buildstream/plugins/sources/deb.py
+++ b/buildstream/plugins/sources/deb.py
@@ -44,7 +44,7 @@ deb - stage files from .deb packages
    # Specify the ref. It's a sha256sum of the file you download.
    ref: 6c9f6f68a131ec6381da82f2bff978083ed7f4f7991d931bfa767b7965ebc94b
 
-   # Specify the basedir to return only the specified dir and it's children
+   # Specify the basedir to return only the specified dir and its children
    base-dir: ''
 
 """
diff --git a/buildstream/plugins/sources/local.py b/buildstream/plugins/sources/local.py
index 7c19e1f90..8b18f9b59 100644
--- a/buildstream/plugins/sources/local.py
+++ b/buildstream/plugins/sources/local.py
@@ -133,7 +133,7 @@ def unique_key(filename):
     if os.path.isdir(filename):
         return "0"
     elif os.path.islink(filename):
-        # For a symbolic link, use the link target as it's unique identifier
+        # For a symbolic link, use the link target as its unique identifier
         return os.readlink(filename)
 
     return utils.sha256sum(filename)
diff --git a/buildstream/plugins/sources/ostree.py b/buildstream/plugins/sources/ostree.py
index 526a91aa0..177bdcc4f 100644
--- a/buildstream/plugins/sources/ostree.py
+++ b/buildstream/plugins/sources/ostree.py
@@ -105,7 +105,7 @@ class OSTreeSource(Source):
         node['ref'] = self.ref = ref
 
     def track(self):
-        # If self.tracking is not specified its' not an error, just silently return
+        # If self.tracking is not specified it's not an error, just silently return
         if not self.tracking:
             return None
 
@@ -151,7 +151,7 @@ class OSTreeSource(Source):
             # The target directory is guaranteed to exist, here we must move the
             # content of out checkout into the existing target directory.
             #
-            # We may not be able to create the target directory as it's parent
+            # We may not be able to create the target directory as its parent
             # may be readonly, and the directory itself is often a mount point.
             #
             try:
diff --git a/buildstream/sandbox/_mount.py b/buildstream/sandbox/_mount.py
index 4fca3d1b0..2dc3df2b5 100644
--- a/buildstream/sandbox/_mount.py
+++ b/buildstream/sandbox/_mount.py
@@ -41,7 +41,7 @@ class Mount():
         self.safe_hardlinks = safe_hardlinks
         self._fuse_mount_options = fuse_mount_options
 
-        # FIXME: When the criteria for mounting something and it's parent
+        # FIXME: When the criteria for mounting something and its parent
         #        mount is identical, then there is no need to mount an additional
         #        fuse layer (i.e. if the root is read-write and there is a directory
         #        marked for staged artifacts directly within the rootfs, they can
diff --git a/buildstream/scriptelement.py b/buildstream/scriptelement.py
index 212402058..3a5d914d0 100644
--- a/buildstream/scriptelement.py
+++ b/buildstream/scriptelement.py
@@ -45,7 +45,7 @@ class ScriptElement(Element):
     __commands = None
     __layout = []
 
-    # The compose element's output is it's dependencies, so
+    # The compose element's output is its dependencies, so
     # we must rebuild if the dependencies change even when
     # not in strict build plans.
     #
@@ -135,7 +135,7 @@ class ScriptElement(Element):
            be made available at the specified location.
         """
         #
-        # Even if this is an empty list by default, make sure that it's
+        # Even if this is an empty list by default, make sure that its
         # instance data instead of appending stuff directly onto class data.
         #
         if not self.__layout:
diff --git a/buildstream/utils.py b/buildstream/utils.py
index 3ef1c4356..7f2f9d5fd 100644
--- a/buildstream/utils.py
+++ b/buildstream/utils.py
@@ -993,7 +993,7 @@ def _tempdir(suffix="", prefix="tmp", dir=None):  # pylint: disable=redefined-bu
 
 # _kill_process_tree()
 #
-# Brutally murder a process and all of it's children
+# Brutally murder a process and all of its children
 #
 # Args:
 #    pid (int): Process ID
diff --git a/doc/bst2html.py b/doc/bst2html.py
index d90eba43f..af35efe24 100755
--- a/doc/bst2html.py
+++ b/doc/bst2html.py
@@ -445,7 +445,7 @@ def run_bst(directory, force, source_cache, description, palette):
     """Run a bst command and capture stdout/stderr in html
 
     This command normally takes a description yaml file, see the CONTRIBUTING
-    file for information on it's format.
+    file for information on its format.
     """
     if not source_cache and os.environ.get('BST_SOURCE_CACHE'):
         source_cache = os.environ['BST_SOURCE_CACHE']
diff --git a/doc/examples/autotools/elements/hello.bst b/doc/examples/autotools/elements/hello.bst
index 510f5b975..ce3ea7466 100644
--- a/doc/examples/autotools/elements/hello.bst
+++ b/doc/examples/autotools/elements/hello.bst
@@ -8,7 +8,7 @@ variables:
   # The hello world example lives in the doc/amhello folder.
   #
   # Set the %{command-subdir} variable to that location
-  # and just have the autotools element run it's commands there.
+  # and just have the autotools element run its commands there.
   #
   command-subdir: doc/amhello
 
diff --git a/doc/examples/flatpak-autotools/files/src/aclocal.m4 b/doc/examples/flatpak-autotools/files/src/aclocal.m4
index f3018f6c8..b0616b92c 100644
--- a/doc/examples/flatpak-autotools/files/src/aclocal.m4
+++ b/doc/examples/flatpak-autotools/files/src/aclocal.m4
@@ -150,7 +150,7 @@ fi])])
 
 # There are a few dirty hacks below to avoid letting 'AC_PROG_CC' be
 # written in clear, in which case automake, when reading aclocal.m4,
-# will think it sees a *use*, and therefore will trigger all it's
+# will think it sees a *use*, and therefore will trigger all its
 # C support machinery.  Also note that it means that autoscan, seeing
 # CC etc. in the Makefile, will ask for an AC_PROG_CC use...
 
diff --git a/doc/examples/junctions/autotools/elements/hello.bst b/doc/examples/junctions/autotools/elements/hello.bst
index 510f5b975..ce3ea7466 100644
--- a/doc/examples/junctions/autotools/elements/hello.bst
+++ b/doc/examples/junctions/autotools/elements/hello.bst
@@ -8,7 +8,7 @@ variables:
   # The hello world example lives in the doc/amhello folder.
   #
   # Set the %{command-subdir} variable to that location
-  # and just have the autotools element run it's commands there.
+  # and just have the autotools element run its commands there.
   #
   command-subdir: doc/amhello
 
diff --git a/doc/source/advanced-features/junction-elements.rst b/doc/source/advanced-features/junction-elements.rst
index d2d223b88..b6065d344 100644
--- a/doc/source/advanced-features/junction-elements.rst
+++ b/doc/source/advanced-features/junction-elements.rst
@@ -43,7 +43,7 @@ Building callHello.bst,
 .. raw:: html
    :file: ../sessions/junctions-build.html
 
-You can see that the hello.bst element and it's dependencies from the autotools
+You can see that the hello.bst element and its dependencies from the autotools
 project have been build as part of the pipeline for callHello.bst.
 
 We can now invoke `bst shell`
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 31984145b..469f99747 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -57,7 +57,7 @@ the ``format-version`` field, e.g.:
   # The minimum base BuildStream format
   format-version: 0
 
-BuildStream will increment it's core YAML format version at least once
+BuildStream will increment its core YAML format version at least once
 in any given minor point release where the format has been extended
 to support a new feature.
 
diff --git a/doc/source/tutorial/autotools.rst b/doc/source/tutorial/autotools.rst
index 8d24ca59c..ea2835838 100644
--- a/doc/source/tutorial/autotools.rst
+++ b/doc/source/tutorial/autotools.rst
@@ -88,7 +88,7 @@ As :ref:`the documentation <format_composition>` mentions:
 The variable we needed to override was ``command-subdir``, which is an
 automatic variable provided by the :mod:`BuildElement <buildstream.buildelement>`
 abstract class. This variable simply instructs the :mod:`BuildElement <buildstream.buildelement>`
-in which subdirectory of the ``%{build-root}`` to run it's commands in.
+in which subdirectory of the ``%{build-root}`` to run its commands in.
 
 One can always display the resolved set of variables for a given
 element's configuration using :ref:`bst show <invoking_show>`:
diff --git a/doc/source/tutorial/first-project.rst b/doc/source/tutorial/first-project.rst
index 1791b198b..18df85bb7 100644
--- a/doc/source/tutorial/first-project.rst
+++ b/doc/source/tutorial/first-project.rst
@@ -73,7 +73,7 @@ The element
 ~~~~~~~~~~~
 The :mod:`import <elements.import>` element can be used to simply add content
 directly to the output artifacts. In this case, it simply takes the ``hello.world`` file
-provided by it's source and stages it directly to the artifact output root.
+provided by its source and stages it directly to the artifact output root.
 
 .. tip::
 
diff --git a/doc/source/tutorial/integration-commands.rst b/doc/source/tutorial/integration-commands.rst
index 8d80eb9a2..ead5be8b2 100644
--- a/doc/source/tutorial/integration-commands.rst
+++ b/doc/source/tutorial/integration-commands.rst
@@ -7,11 +7,11 @@ performed at installation time, otherwise it will not run properly.
 
 This is especially true in cases where a daemon or library interoperates
 with third party extensions and needs to maintain a system wide cache whenever
-it's extensions are installed or removed; system wide font caches are an example
+its extensions are installed or removed; system wide font caches are an example
 of this.
 
 In these cases we use :ref:`integration commands <public_integration>` to
-ensure that a runtime is ready to run after all of it's components have been *staged*.
+ensure that a runtime is ready to run after all of its components have been *staged*.
 
 .. note::
 
@@ -60,10 +60,10 @@ we've used any :ref:`builtin public data <public_builtin>`.
 
 Public data is a free form portion of an element's configuration and
 is not necessarily understood by the element on which it is declared, public
-data is intended to be read by it's reverse dependency elements.
+data is intended to be read by its reverse dependency elements.
 
 This allows annotations on some elements to inform elements later in
-the dependency chain about details of it's artifact, or to suggest how
+the dependency chain about details of its artifact, or to suggest how
 it should be processed.
 
 
diff --git a/doc/source/using_configuring_artifact_server.rst b/doc/source/using_configuring_artifact_server.rst
index 2c4e761ba..b25b5aecf 100644
--- a/doc/source/using_configuring_artifact_server.rst
+++ b/doc/source/using_configuring_artifact_server.rst
@@ -79,7 +79,7 @@ in a system wide location, with ``pip3 install .`` in the BuildStream
 checkout directory.
 
 Otherwise, some tinkering is required to ensure BuildStream is available
-in ``PATH`` when it's companion ``bst-artifact-server`` program is run
+in ``PATH`` when its companion ``bst-artifact-server`` program is run
 remotely.
 
 You can install only the artifact server companion program without
diff --git a/tests/artifactcache/config.py b/tests/artifactcache/config.py
index 8ab0ecee1..df40d1073 100644
--- a/tests/artifactcache/config.py
+++ b/tests/artifactcache/config.py
@@ -113,7 +113,7 @@ def test_artifact_cache_precedence(tmpdir, override_caches, project_caches, user
 
 
 # Assert that if either the client key or client cert is specified
-# without specifying it's counterpart, we get a comprehensive LoadError
+# without specifying its counterpart, we get a comprehensive LoadError
 # instead of an unhandled exception.
 @pytest.mark.datafiles(DATA_DIR)
 @pytest.mark.parametrize('config_key, config_value', [
diff --git a/tests/completions/completions.py b/tests/completions/completions.py
index 50b41f7b3..e6d15e68a 100644
--- a/tests/completions/completions.py
+++ b/tests/completions/completions.py
@@ -76,7 +76,7 @@ def assert_completion(cli, cmd, word_idx, expected, cwd=None):
         words = result.output.splitlines()
 
     # The order is meaningless, bash will
-    # take the results and order it by it's
+    # take the results and order it by its
     # own little heuristics
     words = sorted(words)
     expected = sorted(expected)
diff --git a/tests/testutils/artifactshare.py b/tests/testutils/artifactshare.py
index d95667227..759fd7b00 100644
--- a/tests/testutils/artifactshare.py
+++ b/tests/testutils/artifactshare.py
@@ -32,7 +32,7 @@ class ArtifactShare():
     def __init__(self, directory, *, total_space=None, free_space=None):
 
         # The working directory for the artifact share (in case it
-        # needs to do something outside of it's backend's storage folder).
+        # needs to do something outside of its backend's storage folder).
         #
         self.directory = os.path.abspath(directory)
 
diff --git a/tests/yaml/data/implicitoverwrite.yaml b/tests/yaml/data/implicitoverwrite.yaml
index 20e5eb76a..957d2c084 100644
--- a/tests/yaml/data/implicitoverwrite.yaml
+++ b/tests/yaml/data/implicitoverwrite.yaml
@@ -1,4 +1,4 @@
-# Composited on top of basics.yaml, overwriting it's children list
+# Composited on top of basics.yaml, overwriting its children list
 children:
 - name: overwrite1
   mood: overwrite1
diff --git a/tests/yaml/data/listappend.yaml b/tests/yaml/data/listappend.yaml
index 889ed80b2..169308c54 100644
--- a/tests/yaml/data/listappend.yaml
+++ b/tests/yaml/data/listappend.yaml
@@ -1,4 +1,4 @@
-# Composited on top of basics.yaml, appending to it's children list
+# Composited on top of basics.yaml, appending to its children list
 children:
   (>):
   - name: appended1
diff --git a/tests/yaml/data/listappendprepend.yaml b/tests/yaml/data/listappendprepend.yaml
index 18471b36c..7e4b59a9c 100644
--- a/tests/yaml/data/listappendprepend.yaml
+++ b/tests/yaml/data/listappendprepend.yaml
@@ -1,4 +1,4 @@
-# Composited on top of basics.yaml, prepending and appending to it's children list
+# Composited on top of basics.yaml, prepending and appending to its children list
 children:
   (<):
   - name: prepended1
diff --git a/tests/yaml/data/listoverwrite.yaml b/tests/yaml/data/listoverwrite.yaml
index 3efdfa7cb..eb9d7b1d9 100644
--- a/tests/yaml/data/listoverwrite.yaml
+++ b/tests/yaml/data/listoverwrite.yaml
@@ -1,4 +1,4 @@
-# Composited on top of basics.yaml, overwriting it's children list
+# Composited on top of basics.yaml, overwriting its children list
 children:
   (=):
   - name: overwrite1
diff --git a/tests/yaml/data/listprepend.yaml b/tests/yaml/data/listprepend.yaml
index 3934c93be..a19a9d5d7 100644
--- a/tests/yaml/data/listprepend.yaml
+++ b/tests/yaml/data/listprepend.yaml
@@ -1,4 +1,4 @@
-# Composited on top of basics.yaml, prepending to it's children list
+# Composited on top of basics.yaml, prepending to its children list
 children:
   (<):
   - name: prepended1
diff --git a/tests/yaml/data/secondappend.yaml b/tests/yaml/data/secondappend.yaml
index 376c4a707..20cfc1ad6 100644
--- a/tests/yaml/data/secondappend.yaml
+++ b/tests/yaml/data/secondappend.yaml
@@ -1,4 +1,4 @@
-# Composited on top of listappend.yaml, appending to it's children list
+# Composited on top of listappend.yaml, appending to its children list
 children:
   (>):
   - name: secondappend1
diff --git a/tests/yaml/data/secondprepend.yaml b/tests/yaml/data/secondprepend.yaml
index 58276c381..5be8b9e72 100644
--- a/tests/yaml/data/secondprepend.yaml
+++ b/tests/yaml/data/secondprepend.yaml
@@ -1,4 +1,4 @@
-# Composited on top of listprepend.yaml, prepending to it's children list
+# Composited on top of listprepend.yaml, prepending to its children list
 children:
   (<):
   - name: secondprepend1
diff --git a/versioneer.py b/versioneer.py
index 48e9b2e25..1c97e0227 100644
--- a/versioneer.py
+++ b/versioneer.py
@@ -1494,7 +1494,7 @@ def get_cmdclass():
         # of Versioneer. A's setup.py imports A's Versioneer, leaving it in
         # sys.modules by the time B's setup.py is executed, causing B to run
         # with the wrong versioneer. Setuptools wraps the sub-dep builds in a
-        # sandbox that restores sys.modules to it's pre-build state, so the
+        # sandbox that restores sys.modules to its pre-build state, so the
         # parent is protected against the child's "import versioneer". By
         # removing ourselves from sys.modules here, before the child build
         # happens, we protect the child from the parent's versioneer too.