Skip to content

Commit

Permalink
unify spelling of kas
Browse files Browse the repository at this point in the history
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 <[email protected]>
[Jan: adjust test case]
Signed-off-by: Jan Kiszka <[email protected]>
  • Loading branch information
fmoessbauer authored and jan-kiszka committed Apr 8, 2024
1 parent 7b6cb81 commit 1a20239
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/userguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)`.
6 changes: 3 additions & 3 deletions docs/userguide/credentials.inc
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/project-configuration.inc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion kas/kas.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
"""

Expand Down
2 changes: 1 addition & 1 deletion kas/libcmds.py
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ def _setup_gitconfig(self):
# overwrite user as kas operates git
config['user'] = {
'email': '[email protected]',
'name': 'Kas User'
'name': 'kas User'
}
if os.environ.get('GIT_CREDENTIAL_HELPER', False):
config['credential'] = {
Expand Down
2 changes: 1 addition & 1 deletion tests/test_build_system.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def test_gitconfig(monkeykas, tmpdir, capsys):
kas.kas(['shell', 'test-oe.yml', '-c',
f'git config --get user.name > {tdir}/user.name'])
with open(f'{tdir}/user.name', 'r') as f:
assert f.readline().strip() == 'Kas User'
assert f.readline().strip() == 'kas User'

monkeykas.setenv('GITCONFIG_FILE', f'{tdir}/gitconfig')
with open(f'{tdir}/gitconfig', 'w') as f:
Expand Down

0 comments on commit 1a20239

Please sign in to comment.