[PATCH v3 3/4] docs: Fold Command Line Usage section into User Guide

1 view
Skip to first unread message

Jan Kiszka

unread,
Jun 22, 2026, 1:20:21 PMJun 22
to kas-...@googlegroups.com, Felix Moessbauer
From: Jan Kiszka <jan.k...@siemens.com>

The Command Line section became incomplete since we moved the plugin
documention with there options over. Also, the kas-container options are
shown in the User Guide only. Rather than trying move things partially
back again, give up on the split between these two top-level sections
and everything into the User Guide.

Signed-off-by: Jan Kiszka <jan.k...@siemens.com>
---
docs/_man/kas.rst | 2 +-
docs/command-line.rst | 15 ---------------
docs/index.rst | 1 -
docs/userguide.rst | 2 ++
docs/userguide/cmdline.rst | 8 ++++++++
docs/userguide/env-vars.rst | 6 ++++++
.../environment-variables.inc | 0
7 files changed, 17 insertions(+), 17 deletions(-)
delete mode 100644 docs/command-line.rst
create mode 100644 docs/userguide/cmdline.rst
create mode 100644 docs/userguide/env-vars.rst
rename docs/{command-line => userguide}/environment-variables.inc (100%)

diff --git a/docs/_man/kas.rst b/docs/_man/kas.rst
index 35aa7f3..bb9d1c4 100644
--- a/docs/_man/kas.rst
+++ b/docs/_man/kas.rst
@@ -34,7 +34,7 @@ For details, see :manpage:`kas-credentials(1)`.
ENVIRONMENT VARIABLES
---------------------

-.. include:: ../command-line/environment-variables.inc
+.. include:: ../userguide/environment-variables.inc

SEE ALSO
--------
diff --git a/docs/command-line.rst b/docs/command-line.rst
deleted file mode 100644
index fd25f16..0000000
--- a/docs/command-line.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-Command Line Usage
-==================
-
-.. argparse::
- :module: kas.kas
- :func: kas_get_argparser
- :prog: kas
- :nosubcommands:
-
-.. _env-vars-label:
-
-Environment Variables
----------------------
-
-.. include:: command-line/environment-variables.inc
diff --git a/docs/index.rst b/docs/index.rst
index c2e771c..5cdd724 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,7 +6,6 @@ Welcome to the kas documentation, a setup tool for bitbake based projects

intro
userguide
- command-line
devguide
format-changelog

diff --git a/docs/userguide.rst b/docs/userguide.rst
index ad6a575..2a17c7c 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -5,8 +5,10 @@ User Guide
:maxdepth: 2

userguide/getting-started
+ userguide/cmdline
userguide/plugins
userguide/project-configuration
userguide/build-attestation
userguide/credentials
userguide/kas-container
+ userguide/env-vars
diff --git a/docs/userguide/cmdline.rst b/docs/userguide/cmdline.rst
new file mode 100644
index 0000000..3e1448e
--- /dev/null
+++ b/docs/userguide/cmdline.rst
@@ -0,0 +1,8 @@
+Command Line Usage
+------------------
+
+.. argparse::
+ :module: kas.kas
+ :func: kas_get_argparser
+ :prog: kas
+ :nosubcommands:
diff --git a/docs/userguide/env-vars.rst b/docs/userguide/env-vars.rst
new file mode 100644
index 0000000..a5a052e
--- /dev/null
+++ b/docs/userguide/env-vars.rst
@@ -0,0 +1,6 @@
+.. _env-vars-label:
+
+Environment Variables
+---------------------
+
+.. include:: environment-variables.inc
diff --git a/docs/command-line/environment-variables.inc b/docs/userguide/environment-variables.inc
similarity index 100%
rename from docs/command-line/environment-variables.inc
rename to docs/userguide/environment-variables.inc
--
2.47.3

Reply all
Reply to author
Forward
0 new messages