Correct grammar, spelling and copyright year in files

Signed-off-by: Andreas Reichel <[email protected]>

Author: Andreas Reichel

LICENSE

@@ -1,6 +1,6 @@
 kas - setup tool for bitbake based projects
 
-Copyright (c) Siemens AG, 2017
+Copyright (c) Siemens AG, 2017-2018
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/conf.py

@@ -60,7 +60,7 @@
 
 # General information about the project.
 project = 'kas'
-copyright = 'Siemens AG, 2017'
+copyright = 'Siemens AG, 2017-2018'
 author = 'Daniel Wagner, Jan Kiszka, Claudius Heine'
 
 # The version info for the project you're documenting, acts as replacement for

kas/__init__.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -28,4 +28,4 @@
 from .configschema import CONFIGSCHEMA
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'

kas/__main__.py

@@ -2,7 +2,7 @@
 #
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -28,6 +28,6 @@
 from .kas import main
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 main()

kas/__version__.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -23,7 +23,7 @@
     This module contains the version of kas.
 """
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 __version__ = '0.18.0'
 

kas/build.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -37,7 +37,7 @@
                       SetupReposStep)
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 
 @kasplugin
@@ -115,7 +115,7 @@ def run(self, args):
 
 class BuildCommand(Command):
     """
-        Implement the bitbake build step.
+        Implements the bitbake build step.
     """
 
     def __init__(self, task):

kas/config.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -28,7 +28,7 @@
 from .includehandler import IncludeHandler, IncludeException
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 
 class Config:
@@ -83,8 +83,8 @@ def get_repos(self):
     def _get_repo_dict(self):
         """
             Returns a dictionary containing the repositories with
-            their name (as it is defined in the config file) as key
-            and the `Repo` instances as value.
+            their names (as it is defined in the config file) as keys
+            and the `Repo` instances as values.
         """
         repo_config_dict = self._config.get('repos', {})
         repo_dict = {}
@@ -113,7 +113,7 @@ def get_bitbake_targets(self):
 
     def get_bitbake_task(self):
         """
-            Return the bitbake task
+            Returns the bitbake task
         """
         return os.environ.get('KAS_TASK',
                               self._config.get('task', 'build'))
@@ -156,7 +156,7 @@ def get_distro(self):
     def get_environment(self):
         """
             Returns the configured environment variables from the configuration
-            file, with possible overwritten values from the environment.
+            file with possible overwritten values from the environment.
         """
         env = self._config.get('env', {})
         return {var: os.environ.get(var, env[var]) for var in env}

kas/configschema.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -24,7 +24,7 @@
     This module contains the schema of the configuration file.
 '''
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 CONFIGSCHEMA = {
     'type': 'object',

kas/context.py

@@ -53,7 +53,7 @@ def get_distro_id_base():
 
 def create_global_context():
     """
-        Create global context as singleton.
+        Creates global context as singleton.
     """
     # pylint: disable=global-statement
     global __context__
@@ -63,7 +63,7 @@ def create_global_context():
 
 def get_context():
     """
-        Return singleton global context.
+        Returns singleton global context.
     """
     return __context__
 
@@ -82,7 +82,7 @@ def __init__(self):
 
     def setup_initial_environ(self):
         """
-            Sets the environment variables for process that are
+            Sets the environment variables for processes that are
             started by kas.
         """
         self.environ = {}
@@ -110,7 +110,7 @@ def setup_initial_environ(self):
     @property
     def build_dir(self):
         """
-            The path of the build directory
+            The path to the build directory
         """
         return os.path.join(self.__kas_work_dir, 'build')
 

kas/includehandler.py

@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -36,12 +36,12 @@
 from . import CONFIGSCHEMA
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 
 class LoadConfigException(Exception):
     """
-        Class for exceptions that appear while loading the configuration file.
+        Class for exceptions that appear while loading a configuration file.
     """
     def __init__(self, message, filename):
         super().__init__('{}: {}'.format(message, filename))
@@ -73,7 +73,7 @@ def load_config(filename):
         logging.error('Config file validation Error:\n%s', error)
 
     if validation_error:
-        raise LoadConfigException('Errors occured while validating the '
+        raise LoadConfigException('Error(s) occured while validating the '
                                   'config file', filename)
 
     try:
@@ -108,16 +108,17 @@ class IncludeHandler:
         contain a dictionary as the base type with and 'includes'
         key containing a list of includes.
 
-        The includes can be specified in two ways, as a string
+        The includes can be specified in two ways: as a string
         containing the relative path from the current file or as a
-        dictionary. The dictionary should have a 'file' key, containing
+        dictionary. The dictionary should have a 'file' key containing
         the relative path to the include file and optionally a 'repo'
-        key, containing the key of the repository. If the 'repo' key is
-        missing the value of the 'file' key is treated the same as if
+        key containing the key of the repository. If the 'repo' key is
+        missing the value of the 'file' key, it is treated the same as if
         just a string was defined, meaning the path is relative to the
-        current config file otherwise its relative to the repository path.
+        current config file. Otherwise it is interpreted relative to
+        the repository path.
 
-        The includes are read and merged depth first from top to buttom.
+        The includes are read and merged from the deepest level upwards.
     """
 
     def __init__(self, top_files):
@@ -126,7 +127,7 @@ def __init__(self, top_files):
     def get_config(self, repos=None):
         """
         Parameters:
-          repos -- A dictionary that maps repo name to directory path
+          repos -- A dictionary that maps repo names to directory paths
 
         Returns:
           (config, repos)
@@ -139,7 +140,7 @@ def get_config(self, repos=None):
 
         def _internal_include_handler(filename):
             """
-            Recursively load include files and find missing repos.
+            Recursively loads include files and finds missing repos.
 
             Includes are done in the following way:
 
@@ -161,7 +162,7 @@ def _internal_include_handler(filename):
              'include-repo2.yml', 'include-repo2.yml', 'topfile.yml']
             On conflict the latter includes overwrite previous ones and
             the current file overwrites every include. (evaluation depth first
-            and from top to buttom)
+            and from top to bottom)
             """
             # pylint: disable=too-many-arguments
 
@@ -219,9 +220,9 @@ def _internal_dict_merge(dest, upd, recursive_merge=True):
             """
             Merges upd recursively into a copy of dest as OrderedDict
 
-            If recursive_merge=False, will use the classic dict.update,
-            or fall back on a manual merge (helpful for non-dict types
-            like FunctionWrapper)
+            If recursive_merge is False, it will use the classic dict.update,
+            otherwise it will fall back on a manual merge (helpful for non-dict
+            types like FunctionWrapper)
             """
             if (not isinstance(dest, Mapping)) \
                     or (not isinstance(upd, Mapping)):

kas/kas.py

@@ -2,7 +2,7 @@
 #
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2017
+# Copyright (c) Siemens AG, 2017-2018
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -53,7 +53,7 @@
 from . import shell
 
 __license__ = 'MIT'
-__copyright__ = 'Copyright (c) Siemens AG, 2017'
+__copyright__ = 'Copyright (c) Siemens AG, 2017-2018'
 
 
 def create_logger():
@@ -90,7 +90,7 @@ def interruption():
 
 def _atexit_handler():
     """
-        Wait for completion of the event loop
+        Waits for completion of the event loop
     """
     loop = asyncio.get_event_loop()
     pending = asyncio.Task.all_tasks()
@@ -100,7 +100,7 @@ def _atexit_handler():
 
 def kas_get_argparser():
     """
-        Creates a argparser for kas with all plugins.
+        Creates an argparser for kas with all plugins.
     """
     parser = argparse.ArgumentParser(description='kas - setup tool for '
                                      'bitbake based project')
@@ -126,7 +126,7 @@ def kas_get_argparser():
 
 def kas(argv):
     """
-        The main entry point of kas.
+        The actual main entry point of kas.
     """
     create_logger()