[PATCH v3 1/4] docs: Fix long lines

[Jan Kiszka]

From: Jan Kiszka <jan.k...@siemens.com>

Missed so far as the checker ignored .inc.

Signed-off-by: Jan Kiszka <jan.k...@siemens.com>
---
docs/command-line/environment-variables.inc | 3 +-
docs/userguide/kas-container-description.inc | 53 +++++++++++---------
2 files changed, 31 insertions(+), 25 deletions(-)

diff --git a/docs/command-line/environment-variables.inc b/docs/command-line/environment-variables.inc
index ef4c0bf..0f01d98 100644
--- a/docs/command-line/environment-variables.inc
+++ b/docs/command-line/environment-variables.inc
@@ -246,7 +246,8 @@ overwritten using the ``env`` section of the config file.
.. |aws_cred| replace:: ``AWS_ROLE_ARN``
``AWS_SHARED_CREDENTIALS_FILE``
``AWS_WEB_IDENTITY_TOKEN_FILE``
-.. |git_cred| replace:: ``GIT_CREDENTIAL_HELPER`` ``GIT_CREDENTIAL_USEHTTPPATH``
+.. |git_cred| replace:: ``GIT_CREDENTIAL_HELPER``
+ ``GIT_CREDENTIAL_USEHTTPPATH``
.. |kas_git_cred_store| replace:: ``KAS_GIT_CREDENTIAL_STORE``
.. |kas_git_cred_socket| replace:: ``KAS_GIT_CREDENTIAL_SOCKET``
.. |ci_server_vars| replace:: ``CI_SERVER_HOST``
diff --git a/docs/userguide/kas-container-description.inc b/docs/userguide/kas-container-description.inc
index 7762511..62a7932 100644
--- a/docs/userguide/kas-container-description.inc
+++ b/docs/userguide/kas-container-description.inc
@@ -1,21 +1,24 @@
-The ``kas-container`` script is a wrapper to run `kas` inside a build container.
-It gives fine grained control over the data that is mapped into the build and
-decouples the build environment from the host system. For details, see
-:ref:`env-vars-label`. The wrapper also takes care of mounting the necessary
-directories and setting up the environment variables inside the container.
+The ``kas-container`` script is a wrapper to run `kas` inside a build
+container. It gives fine grained control over the data that is mapped into the
+build and decouples the build environment from the host system. For details,
+see :ref:`env-vars-label`. The wrapper also takes care of mounting the
+necessary directories and setting up the environment variables inside the
+container.

.. note::
The ``kas-container`` script has limited support for Git worktrees. Regular
- Git operations on the checked-out repository are supported. However, executing
- any ``git worktree ...`` command inside the container is not allowed.
+ Git operations on the checked-out repository are supported. However,
+ executing any ``git worktree ...`` command inside the container is not
+ allowed.

-By default ``kas-container`` uses the official images provided by the kas project:
-``ghcr.io/siemens/kas/kas[-isar]:<version>``. To specify your own image set the
-``KAS_CONTAINER_IMAGE`` environment variable. The ``kas-container`` script version
-should match the kas version inside the container. If kas detects that is was called
-from ``kas-container`` and the versions do not match, a warning is emitted. This
-limitation might be lessened in the future, once a stable interface between
-``kas-container`` and kas is introduced.
+By default ``kas-container`` uses the official images provided by the kas
+project: ``ghcr.io/siemens/kas/kas[-isar]:<version>``. To specify your own
+image set the ``KAS_CONTAINER_IMAGE`` environment variable. The
+``kas-container`` script version should match the kas version inside the
+container. If kas detects that is was called from ``kas-container`` and the
+versions do not match, a warning is emitted. This limitation might be lessened
+in the future, once a stable interface between ``kas-container`` and kas is
+introduced.

From version ``5.0`` onward, kas offers images built on several base
distributions. Select a distribution by setting the environment variable
@@ -30,15 +33,17 @@ As container backends, Docker and
Podman are supported. To force the use of podman over docker, set
``KAS_CONTAINER_ENGINE=podman``. For details, see :ref:`env-vars-label`.

-Running under docker in `rootless mode <https://docs.docker.com/engine/security/rootless/>`_
-is partially supported. It is recommended to use a distinct ``KAS_WORK_DIR`` outside of the
-calling directory (repo-dir), as kas temporarily changes the ownership of the working
-directory during its operation. All files managed by kas (including the repos) must not be
-written to from the host. To completely remove all data managed by kas, use
-``kas-container purge``. This also restores the directory owners of the dirs passed to kas,
-so they can be removed from the host.
+Running under docker in
+`rootless mode <https://docs.docker.com/engine/security/rootless/>`_ is
+partially supported. It is recommended to use a distinct ``KAS_WORK_DIR``
+outside of the calling directory (repo-dir), as kas temporarily changes the
+ownership of the working directory during its operation. All files managed by
+kas (including the repos) must not be written to from the host. To completely
+remove all data managed by kas, use ``kas-container purge``. This also restores
+the directory owners of the dirs passed to kas, so they can be removed from the
+host.

.. note::
- The ISAR build system is compatible with rootless execution in ``isar-rootless``
- mode only. The ``isar`` and ``isar-privileged`` modes fall back to the system docker
- or podman instance.
+ The ISAR build system is compatible with rootless execution in
+ ``isar-rootless`` mode only. The ``isar`` and ``isar-privileged`` modes
+ fall back to the system docker or podman instance.
--
2.47.3