[elbe-devel] [PATCH v2] add cyclonedx-sbom documentation

[Eduard Krein]

Add documenation for the cyclonedx SBOM generator.

Signed-off-by: Eduard Krein <eduard.krein at linutronix.de>
---
 docs/elbe-cyclonedx-sbom.rst              | 46 +++++++++++++++++++++++
 newsfragments/+cyclonedx-sbom.feature.rst |  6 +++
 2 files changed, 52 insertions(+)
 create mode 100644 docs/elbe-cyclonedx-sbom.rst
 create mode 100644 newsfragments/+cyclonedx-sbom.feature.rst

diff --git a/docs/elbe-cyclonedx-sbom.rst b/docs/elbe-cyclonedx-sbom.rst
new file mode 100644
index 00000000..91178a87
--- /dev/null
+++ b/docs/elbe-cyclonedx-sbom.rst
@@ -0,0 +1,46 @@
+.. attention::
+
+   This tool is still experimental.
+
+*******************
+elbe-cyclonedx-sbom
+*******************
+
+NAME
+====
+
+elbe-cyclonedx-sbom - Generator for Software Bill of Materials
+in OWASP's CycloneDX format.
+
+SYNOPSIS
+========
+
+   ::
+
+      elbe cyclonedx-sbom [option]
+
+DESCRIPTION
+===========
+
+Generate OWASP CycloneDX Software Bill of Materials from an ELBE build directory.
+For that, it uses files inside the build directory of an ELBE project.
+
+OPTIONS
+=======
+
+-d <dir>
+   Build directory generated by an ELBE project.
+
+Examples
+========
+
+-  Generate a CycloneDX SBOM from the CycloneDX unittest:
+
+   ::
+
+      $ elbe cyclonedx-sbom -d elbe/elbepack/tests/cyclonedx/build-simple-example
+
+ELBE
+====
+
+Part of the ``elbe(1)`` suite
diff --git a/newsfragments/+cyclonedx-sbom.feature.rst b/newsfragments/+cyclonedx-sbom.feature.rst
new file mode 100644
index 00000000..5f86ca62
--- /dev/null
+++ b/newsfragments/+cyclonedx-sbom.feature.rst
@@ -0,0 +1,6 @@
+.. attention::
+
+    This tool is still experimental.
+
+A cylonedx-sbom generator is provided, which generates
+Software Bill of Materials from ELBE builds.
-- 
2.39.2