PTU5KAS/docs/format-changelog.rst
Felix Moessbauer 76db0706f3 menu plugin: track root repo dir
This patch adds a new top-level schema node `_source_dir` which is used
to track the top repo dir on auto-generated kas files. This node is
generated by the kas menu plugin and provides the absolute path to the
top repo dir at time of invoking the plugin. When later calling any other
kas operation that performs a checkout, this node is evaluated and the
top repo dir is set accordingly. This tracking is required when the
build command is executed from another dir than the top repo dir, as the
repo-dir cannot be computed by kas in this case (the .config.yaml file
is in the KAS_WORK_DIR, not in the repo dir).

Proposed-by: Peter Hoyes <Peter.Hoyes@arm.com>
Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com>
[Jan: aligned format-changelog text, simplified load_config returning]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2023-05-30 11:07:53 +02:00

143 lines
2.6 KiB
ReStructuredText

Configuration Format Changes
============================
Version 1 (Alias '0.10')
------------------------
Added
~~~~~
- Include mechanism
- Version check
Version 2
---------
Changed
~~~~~~~
- Configuration file versions are now integers
Fixed
~~~~~
- Including files from repos that are not defined in the current file
Version 3
---------
Added
~~~~~
- ``Task`` key that allows to specify which task to run (``bitbake -c``)
Version 4
---------
Added
~~~~~
- ``Target`` key now allows to be a list of target names
Version 5
---------
Changed behavior
~~~~~~~~~~~~~~~~
- Using ``multiconfig:*`` targets adds appropriate ``BBMULTICONFIG`` entries to
the ``local.conf`` automatically.
Version 6
---------
Added
~~~~~
- ``env`` key now allows to pass custom environment variables to the bitbake
build process.
Version 7
---------
Added
~~~~~
- ``type`` property to ``repos`` to be able to express which version control
system to use.
Version 8
---------
Added
~~~~~
- ``patches`` property to ``repos`` to be able to apply additional patches to
the repo.
Version 9
---------
Added
~~~~~
- ``defaults`` key can now be used to set a default value for the repository
property ``refspec`` and the repository patch property ``repo``. These
default values will be used if the appropriate properties are not defined
for a given repository or patch.
Version 10
----------
Added
~~~~~
- ``build_system`` property to pre-select OE or Isar.
Version 11
----------
Changed behavior
~~~~~~~~~~~~~~~~
- String item ``includes`` are now using repo-relative paths. File-relative is
still supported by issues a deprecation warning.
- bblayers.conf is generated with ``BBPATH`` and ``BBFILES`` preset to common
defaults. Those can still be overwritten via ``bblayers_conf_headers``.
Added
~~~~~
- ``menu_configuration`` key stores the selections done via ``kas menu`` in a
configuration file. It is only evaluated by that plugin.
Version 12
----------
Added
~~~~~
- For repositories, ``url`` and ``path`` can now be overridden with a
null-value to switch between version-controlled repositories and unversioned
local folders.
Version 13
----------
Added
~~~~~
- Variables used in the ``env`` section can now be assigned 'None' as value. In
this case the variables are only exported to the bb env whitelist.
Version 14
----------
Added
~~~~~
- The ``overrides`` top-level entry can be used to pin floating repo refspecs.
- ``_source_dir`` top-level entry is auto-generated when using the menu plugin
and provides the path to the top repo at time of invoking the plugin.