[PATCH 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.

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 ++++++++--------
kas-container | 2 +-
kas/schema-kas.json | 2 +-
11 files changed, 26 insertions(+), 26 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/kas-container b/kas-container
index 55bdcfca6..ffc682331 100755
--- a/kas-container
+++ b/kas-container
@@ -516,7 +516,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]

On 16.07.26 13:21, Felix Moessbauer wrote:
> 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.
>

There might be more references to "plugin" when we should talk about
commands:

- docs/userguide/project-configuration.rst
- docs/userguide/getting-started.rst
- docs/userguide/environment-variables.inc

Did you check them?
Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center