PTU5KAS/docs
Felix Moessbauer 5b3e238128 add plugin to dump flattened config
This patch adds a new plugin 'dump' which resolves all kas config
includes and combines them in a single file. The format of the output
file can either be JSON or YAML. In case of YAML, the generated config
fulfills the kas-config schema and can be used as input to kas again.
In addition, the generated files can be used by external tools to
analyse the dependencies and versions of the project.

While the generated configuration is semantically identical to the
input config, we do not guarantee binary compatibility as especially
YAML provides multiple ways to serialize strings and null values.
Not giving this guarantee makes it easier to evolve and maintain the plugin.

The plugin itself extends the checkout plugin, as referenced repos have
to be checked-out first to resolve cross-repo references. This also
requires, that the declared refspec of all referenced repos can actually
be found and checked out.

Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2022-12-13 14:38:41 +01:00
..
_static Fixed wrapping of cell content in readthedocs style 2017-06-28 15:12:15 +02:00
command-line.rst forward DISTRO_APT_PREMIRRORS environment variable 2022-11-15 11:54:34 +01:00
conf.py scripts: Remove pylint 2018-12-07 09:55:26 +01:00
devguide.rst docs: Update devguide to handle new plugin structure 2020-11-13 07:41:01 +01:00
format-changelog.rst add conditional environment variables 2022-11-10 19:03:48 +01:00
index.rst docs: Move command line details to a separate page 2020-11-13 07:41:57 +01:00
intro.rst docs: Fix title of intro page 2020-11-13 07:42:24 +01:00
Makefile Added initial sphinx documentation 2017-06-28 15:12:15 +02:00
requirements.txt readthedocs: Add configuration file 2021-11-22 19:20:14 +01:00
userguide.rst add plugin to dump flattened config 2022-12-13 14:38:41 +01:00