kiwi-el8/doc/source/concept_and_workflow/runtime_configuration.rst
Marcus Schäfer caf1b633fe
Update documentation in content and structure
This commit adds a documentation for the KIWI XML description.
In contrast to the former auto generated code from the XML
schema this document can now finally be used as a reference.
Along with that new chapter all auto generated and static
html content as been deleted. Also all helper scripts around
the proprietary oxygen tool and our schema doc generator
has been deleted. Auto generating this information does not
lead to a reference guide people can really work with.
As a consequence to these changes this commit also includes
some changes of the structure such that no information written
by other people in the past gets lost. This Fixes #1421
and Fixes #1474
2020-07-01 10:42:51 +02:00

21 lines
706 B
ReStructuredText

.. _runtime_config:
The Runtime Configuration File
------------------------------
{kiwi} supports an additional configuration file for runtime specific
settings that do not belong into the image description but which are
persistent and would be unsuitable for command line parameters.
The runtime configuration file must adhere to the `YAML
<https://yaml.org/>`_ syntax. {kiwi} searches for the runtime configuration
file in the following locations:
1. :file:`~/.config/kiwi/config.yml`
2. :file:`/etc/kiwi.yml`
A default runtime config file in :file:`/etc/kiwi.yml` is provided with
the python3-kiwi package. The file contains all settings as comments
including a short description of each setting.