[PATCH 6/6] Add changelog for the recipe API

[Jan Kiszka <jan.kiszka@siemens.com>]

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

This uses the last release v0.5 as baseline and documents changes that
affect own recipes and layers using Isar. Hopefully, this caught all of
them since v0.5.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 RECIPE-API-CHANGELOG.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 RECIPE-API-CHANGELOG.md

diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
new file mode 100644
index 0000000..601fc6b
--- /dev/null
+++ b/RECIPE-API-CHANGELOG.md
@@ -0,0 +1,59 @@
+Recipe API Changelog
+====================
+
+Baseline: Release v0.5
+
+Changes in v0.6
+---------------
+
+### Separate do_prepare_build task
+
+All Debianizations of source trees and any further programmatic patching has to
+be moved from the dpkg_runbuild() task to this new task.
+
+### ISAR_CROSS_COMPILE support
+
+Isar now supports cross-compilation. When enabled via `ISAR_CROSS_COMPILE = "1"`
+in a global configuration file, all recipes that do not overwrite this variable
+will build cross-compiled.
+
+If a recipe is not cross-compatible, it should set `ISAR_CROSS_COMPILE = "0"`.
+Then also all its dependencies that are built by Isar must opt out from
+cross-building.
+
+### wic image type, removal of manual wic invocation
+
+Images that are described by wic files are now generated during the build by
+setting `IMAGE_TYPE = "wic-img"`. The manual invocation of wic after the
+bitbake run is no longer needed nor supported.
+
+### Optional kernel installation
+
+The installation of a Linux kernel into the isar-image-base can be skipped by
+setting `KERNEL_NAME = ""`.
+
+### Corrected semantic of `S`
+
+The `S` variable is now defined as NOT including `WORKDIR`, like in OE, Gentoo
+and others. If it was set to, e.g., `S = "sources"` in a recipe so far, it must
+be defined as `S = ${WORKDIR}/sources` from now on.
+
+### DISTRO and DISTRO_ARCH are available as OVERRIDES
+
+Bitbake variables can now also refer to the DISTRO as well as the DISTRO_ARCH
+for overrides.
+
+### Set ISAR_RELEASE_CMD in own top-layer
+
+Isar now populates /etc/os-release with information about the image. In order
+to identify the revision of the top layer that controlled the image build with
+all its dependencies, set ISAR_RELEASE_CMD so that it picks up the required
+information.
+
+If the top-layer is managed in git, set `LAYERDIR_mylayer = "${LAYERDIR}"` in
+`conf/layer.conf` and add something along
+
+    ISAR_RELEASE_CMD = "git -C ${LAYERDIR_mylayer} describe --tags --dirty \
+                            --match 'v[0-9].[0-9]*'"
+
+in the image recipe (or `isar-image-base.bbappend`) of that layer.
-- 
2.16.4