[PATCH v2 1/1] docs: Refer to subcommands as commands

[Felix Moessbauer]

Continue the documentation restructuring from a7f560194d by replacing
user-facing plugin terminology with command terminology. While
internally we still call them plugins, the user interfaces with kas via
the CLI and there these plugins map to subcommands.

No functional change.

Changes since v1:

Addressed review comments, changed "plugin" to "command" where applicable in:
- docs/userguide/project-configuration.rst
- docs/userguide/getting-started.rst
- docs/userguide/environment-variables.inc

Best regards,
Felix

Signed-off-by: Felix Moessbauer <felix.mo...@siemens.com>
---
docs/_man/kas-plugin-build.rst | 4 ++--
docs/_man/kas-plugin-checkout.rst | 4 ++--
docs/_man/kas-plugin-diff.rst | 4 ++--
docs/_man/kas-plugin-dump.rst | 4 ++--
docs/_man/kas-plugin-for-all-repos.rst | 4 ++--
docs/_man/kas-plugin-lock.rst | 4 ++--
docs/_man/kas-plugin-menu.rst | 4 ++--
docs/_man/kas-plugin-shell.rst | 4 ++--
docs/conf.py | 16 ++++++++--------
docs/userguide/environment-variables.inc | 4 ++--
docs/userguide/getting-started.rst | 4 ++--
docs/userguide/project-configuration.rst | 8 ++++----
kas-container | 2 +-
kas/schema-kas.json | 2 +-
14 files changed, 34 insertions(+), 34 deletions(-)

diff --git a/docs/_man/kas-plugin-build.rst b/docs/_man/kas-plugin-build.rst
index fb51ddad4..ff683dfab 100644
--- a/docs/_man/kas-plugin-build.rst
+++ b/docs/_man/kas-plugin-build.rst
@@ -1,7 +1,7 @@
:orphan:

-kas build plugin
-================
+kas build command
+=================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-checkout.rst b/docs/_man/kas-plugin-checkout.rst
index d86fe854f..7ced7aee6 100644
--- a/docs/_man/kas-plugin-checkout.rst
+++ b/docs/_man/kas-plugin-checkout.rst
@@ -1,7 +1,7 @@
:orphan:

-kas checkout plugin
-===================
+kas checkout command
+====================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-diff.rst b/docs/_man/kas-plugin-diff.rst
index 2affe1577..e3a770cfa 100644
--- a/docs/_man/kas-plugin-diff.rst
+++ b/docs/_man/kas-plugin-diff.rst
@@ -1,7 +1,7 @@
:orphan:

-kas diff plugin
-===============
+kas diff command
+================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-dump.rst b/docs/_man/kas-plugin-dump.rst
index 1270f888d..e971b5790 100644
--- a/docs/_man/kas-plugin-dump.rst
+++ b/docs/_man/kas-plugin-dump.rst
@@ -1,7 +1,7 @@
:orphan:

-kas dump plugin
-===============
+kas dump command
+================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-for-all-repos.rst b/docs/_man/kas-plugin-for-all-repos.rst
index 047927456..2b3fd2d39 100644
--- a/docs/_man/kas-plugin-for-all-repos.rst
+++ b/docs/_man/kas-plugin-for-all-repos.rst
@@ -1,7 +1,7 @@
:orphan:

-kas for-all-repos plugin
-========================
+kas for-all-repos command
+=========================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-lock.rst b/docs/_man/kas-plugin-lock.rst
index f1c713218..76bc85388 100644
--- a/docs/_man/kas-plugin-lock.rst
+++ b/docs/_man/kas-plugin-lock.rst
@@ -1,7 +1,7 @@
:orphan:

-kas lock plugin
-===============
+kas lock command
+================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-menu.rst b/docs/_man/kas-plugin-menu.rst
index d0c3cdc74..c1cb920c8 100644
--- a/docs/_man/kas-plugin-menu.rst
+++ b/docs/_man/kas-plugin-menu.rst
@@ -1,7 +1,7 @@
:orphan:

-kas menu plugin
-===============
+kas menu command
+================

.. argparse::
:module: kas.kas
diff --git a/docs/_man/kas-plugin-shell.rst b/docs/_man/kas-plugin-shell.rst
index 34af125fe..c664f9b23 100644
--- a/docs/_man/kas-plugin-shell.rst
+++ b/docs/_man/kas-plugin-shell.rst
@@ -1,7 +1,7 @@
:orphan:

-kas shell plugin
-================
+kas shell command
+=================

.. argparse::
:module: kas.kas
diff --git a/docs/conf.py b/docs/conf.py
index 96b5553f6..0706251e1 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -328,9 +328,9 @@ man_pages = [
('_man/kas-container',
'kas-container', 'a setup tool for bitbake based projects',
[author], 1),
- ('_man/kas-plugin-build', 'kas-build', 'kas build plugin',
+ ('_man/kas-plugin-build', 'kas-build', 'kas build command',
[author], 1),
- ('_man/kas-plugin-checkout', 'kas-checkout', 'kas checkout plugin',
+ ('_man/kas-plugin-checkout', 'kas-checkout', 'kas checkout command',
[author], 1),
('_man/kas-plugin-clean', 'kas-clean', 'kas clean command',
[author], 1),
@@ -339,20 +339,20 @@ man_pages = [
('_man/kas-plugin-cleansstate', 'kas-cleansstate',
'kas cleansstate command',
[author], 1),
- ('_man/kas-plugin-diff', 'kas-diff', 'kas diff plugin',
+ ('_man/kas-plugin-diff', 'kas-diff', 'kas diff command',
[author], 1),
- ('_man/kas-plugin-dump', 'kas-dump', 'kas dump plugin',
+ ('_man/kas-plugin-dump', 'kas-dump', 'kas dump command',
[author], 1),
('_man/kas-plugin-for-all-repos',
- 'kas-for-all-repos', 'kas for-all-repos plugin',
+ 'kas-for-all-repos', 'kas for-all-repos command',
[author], 1),
- ('_man/kas-plugin-lock', 'kas-lock', 'kas lock plugin',
+ ('_man/kas-plugin-lock', 'kas-lock', 'kas lock command',
[author], 1),
- ('_man/kas-plugin-menu', 'kas-menu', 'kas menu plugin',
+ ('_man/kas-plugin-menu', 'kas-menu', 'kas menu command',
[author], 1),
('_man/kas-plugin-purge', 'kas-purge', 'kas purge command',
[author], 1),
- ('_man/kas-plugin-shell', 'kas-shell', 'kas shell plugin',
+ ('_man/kas-plugin-shell', 'kas-shell', 'kas shell command',
[author], 1),
('_man/kas-project-config',
'kas-project-config', 'kas project configuration',
diff --git a/docs/userguide/environment-variables.inc b/docs/userguide/environment-variables.inc
index 42ede08bf..4863c97f3 100644
--- a/docs/userguide/environment-variables.inc
+++ b/docs/userguide/environment-variables.inc
@@ -150,10 +150,10 @@ overwritten using the ``env`` section of the config file.
| | script. |
+--------------------------+--------------------------------------------------+
| ``SHELL`` | The shell to start when using the ``shell`` |
-| (C,K,E) | plugin and in the bitbake environment. |
+| (C,K,E) | command and in the bitbake environment. |
+--------------------------+--------------------------------------------------+
| ``TERM`` | The terminal options used in the ``shell`` |
-| (C,K,E) | plugin and in the bitbake environment. |
+| (C,K,E) | command and in the bitbake environment. |
+--------------------------+--------------------------------------------------+
| ``TZ`` (C) | Timezone settings. |
+--------------------------+--------------------------------------------------+
diff --git a/docs/userguide/getting-started.rst b/docs/userguide/getting-started.rst
index 787e5a26c..65927e7f4 100644
--- a/docs/userguide/getting-started.rst
+++ b/docs/userguide/getting-started.rst
@@ -41,8 +41,8 @@ This project depends on
- jsonschema Python 3 package
- PyYAML Python 3 package
- GitPython Python 3 package
-- kconfiglib Python 3 package (optional, for menu plugin)
-- NEWT Python 3 distro package (optional, for menu plugin)
+- kconfiglib Python 3 package (optional, for ``menu`` command)
+- NEWT Python 3 distro package (optional, for ``menu`` command)
- python-gnupg Python 3 package (optional, for signature verification)

Usage
diff --git a/docs/userguide/project-configuration.rst b/docs/userguide/project-configuration.rst
index 13cb0ef36..439341cdc 100644
--- a/docs/userguide/project-configuration.rst
+++ b/docs/userguide/project-configuration.rst
@@ -225,8 +225,8 @@ and its corresponding lockfile ``kas/kas-isar.lock.yml``.
isar:
commit: 0336610df8bb0adce76ef8c5a921c758efed9f45

-The ``lock`` plugin provides helpers to simplify the creation and update
-of lockfiles. For details, see the plugins documentation: :mod:`kas.plugins.lock`.
+The ``lock`` command provides helpers to simplify the creation and update
+of lockfiles. For details, see the command's documentation: :mod:`kas.plugins.lock`.

Configuration reference
~~~~~~~~~~~~~~~~~~~~~~~
@@ -443,14 +443,14 @@ Configuration reference
Each variable
corresponds to a Kconfig configuration variable and can be of the types
string, boolean or integer. The content of this key is typically
- maintained by the ``kas menu`` plugin in a ``.config.yaml`` file.
+ maintained by the ``kas menu`` command in a ``.config.yaml`` file.

``artifacts``: dict [optional]
:kasschemadesc:`artifacts`
Each key-value pair describes an identifier and a path relative to the kas
build dir, whereby the path can contain wildcards like ``*``. Unix-style
globbing is applied to all paths. In case no artifact is found, the build is
- considered successful, if not stated otherwise by the used plugin and mode
+ considered successful, if not stated otherwise by the used command and mode
of operation.

.. note:: There are no further semantics attached to the identifiers (yet).
diff --git a/kas-container b/kas-container
index d00dc933e..be641caf3 100755
--- a/kas-container
+++ b/kas-container
@@ -522,7 +522,7 @@ if [ "${KAS_CMD}" = "menu" ]; then

# When using the menu plugin, we need to track the KAS_REPO_DIR outside
# of the container to later allow a simple `kas-container build`. For
- # that, we tell the kas menu plugin via an env-var about the location
+ # that, we tell the kas menu command via an env-var about the location
# on the host. This data is then added to the .config.yaml where it can
# be evaluated by the next invocation of kas-container.

diff --git a/kas/schema-kas.json b/kas/schema-kas.json
index 489650ba3..bddd6d0fd 100644
--- a/kas/schema-kas.json
+++ b/kas/schema-kas.json
@@ -454,7 +454,7 @@
"description": "Path to the top repo at time of invoking the plugin (auto-generated by the menu plugin). It must not be set manually and might only be defined in the top-level ``.config.yaml`` file.", "type": "string"
},
"_source_dir_host": {
- "description": "Source directory of the config file on the host (auto-generated by kas menu plugin, when using kas-container).",
+ "description": "Source directory of the config file on the host (auto-generated by kas menu command, when using kas-container).",
"type": "string"
},
"buildtools": {
--
2.53.0

[Jan Kiszka]

"The lock command simplifies" ...

Should I fold that small change above in?

Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center

[MOESSBAUER, Felix]

Yes, please. Thanks!

Felix

[Jan Kiszka]

Done and applied, thanks.