From 015d1e54230c7e7fc34e7c14e2c5305f29531f45 Mon Sep 17 00:00:00 2001
From: Marta Rybczynska <marta.rybczynska@huawei.com>
Date: Fri, 19 Aug 2022 09:26:53 +0200
Subject: [PATCH] bblayers.conf.sample: update a comment

Update the comment on ONIRO_LAYERS_CONF_VERSION to tell the user
that they also need to change ONIRO_REQUIRED_LAYERS_CONF_VERSION
and where to find it. Cover both cases of the sample and the
local file.

Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com>
---
 flavours/linux/bblayers.conf.sample | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/flavours/linux/bblayers.conf.sample b/flavours/linux/bblayers.conf.sample
index d8540b01..efef18fd 100644
--- a/flavours/linux/bblayers.conf.sample
+++ b/flavours/linux/bblayers.conf.sample
@@ -2,9 +2,14 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-# Bump this each time bblayers.conf.sample changes incompatibly. For example,
-# when integrating new layers. It needs to be in sync with
-# ONIRO_REQUIRED_LAYERS_CONF_VERSION for associated sanity check to pass.
+# If you are changing bblayers.conf.sample and introduce an incompatible
+# change (like adding new layers), increment the ONIRO_LAYERS_CONF_VERSION value
+# here and ONIRO_REQUIRED_LAYERS_CONF_VERSION in conf/distro/include/oniro.inc
+
+# If you are changing bblayers.conf because of a build time error mismatch on
+# ONIRO_REQUIRED_LAYERS_CONF_VERSION, update the value below to the
+# required one after you have merged in all the changes from the sample file.
+
 ONIRO_LAYERS_CONF_VERSION = "1"
 
 BBPATH = "${TOPDIR}"
-- 
GitLab