From ba93359792965d1d50ea11eed25658cc703a8186 Mon Sep 17 00:00:00 2001 From: Felix Moessbauer Date: Mon, 8 Apr 2024 09:02:05 +0200 Subject: [PATCH] unify spelling of kas The kas tool should always be written as 'kas', not 'KAS' or 'Kas'. This patch unifies the spelling across the whole project. Signed-off-by: Felix Moessbauer Signed-off-by: Jan Kiszka --- docs/userguide.rst | 2 +- docs/userguide/credentials.inc | 6 +++--- docs/userguide/project-configuration.inc | 2 +- kas/kas.py | 2 +- kas/libcmds.py | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/userguide.rst b/docs/userguide.rst index 3fcc5494..bdcc98ee 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -155,5 +155,5 @@ Credential Handling .. only:: man - KAS provides various mechanisms to inject credentials into the build. + kas provides various mechanisms to inject credentials into the build. For details, see :manpage:`kas-credentials(1)`. diff --git a/docs/userguide/credentials.inc b/docs/userguide/credentials.inc index ae1c6fba..096aa8a2 100644 --- a/docs/userguide/credentials.inc +++ b/docs/userguide/credentials.inc @@ -1,8 +1,8 @@ -KAS provides various mechanisms to inject credentials into the build. +kas provides various mechanisms to inject credentials into the build. By using :ref:`env-vars-label`, a fine grained control is possible. All credentials are made available both to KAS, as well as inside the build environment. However, not all mechanisms are natively supported by all tools. -As KAS might need to modify credentials and config files, these are copied +As kas might need to modify credentials and config files, these are copied into the isolated environment first. One exception is the SSH folder, where changes are only performed if not yet present on the host. @@ -24,7 +24,7 @@ Git Configuration A ``.gitconfig`` file can be used to provide credentials as well as url rewrites of git repositories (``insteadof``). To support the patching -of git repositories, KAS injects a ``[user]`` section, possibly overwriting +of git repositories, kas injects a ``[user]`` section, possibly overwriting an existing one. When running in the Github CI, the ``.gitconfig`` file is automatically injected. In addition, credential helpers can be used by setting the corresponding environment variables. These are added to the diff --git a/docs/userguide/project-configuration.inc b/docs/userguide/project-configuration.inc index d4e56841..510d471b 100644 --- a/docs/userguide/project-configuration.inc +++ b/docs/userguide/project-configuration.inc @@ -161,7 +161,7 @@ configuration flaws that can easily emerge from them. Working with lockfiles ~~~~~~~~~~~~~~~~~~~~~~ -KAS supports the use of lockfiles to pinpoint repositories to exact commit ID +kas supports the use of lockfiles to pinpoint repositories to exact commit ID (e.g. SHA-1 refs for git). A lockfile hereby only overrides the commit ID defined in a kas file. When performing the checkout operation (or any other operation that performs a checkout), kas checks if a file named diff --git a/kas/kas.py b/kas/kas.py index 958a5e0a..6af0b4c4 100644 --- a/kas/kas.py +++ b/kas/kas.py @@ -22,7 +22,7 @@ """ This module is the main entry point for kas, setup tool for bitbake based projects. In case of user errors (e.g. invalid configuration, repo fetch - failure) KAS exits with error code 2, while exiting with 1 for internal + failure) kas exits with error code 2, while exiting with 1 for internal errors. For details on error handling, see :mod:`kas.kasusererror`. """ diff --git a/kas/libcmds.py b/kas/libcmds.py index 1399e725..c3d4cdca 100644 --- a/kas/libcmds.py +++ b/kas/libcmds.py @@ -234,7 +234,7 @@ def _setup_gitconfig(self): # overwrite user as kas operates git config['user'] = { 'email': 'kas@example.com', - 'name': 'Kas User' + 'name': 'kas User' } if os.environ.get('GIT_CREDENTIAL_HELPER', False): config['credential'] = {