From 600c8f2427989766d02ce69a8e6c5d212d5f87d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Danis?= <frederic.danis@collabora.com>
Date: Fri, 1 Mar 2019 15:14:45 +0100
Subject: [PATCH] Add comments to recipe samples
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Frédéric Danis <frederic.danis@collabora.com>
---
 apertis-sample-image-basesdk.yaml       | 4 ++++
 apertis-sample-image-mx6qsabrelite.yaml | 1 +
 apertis-sample-image-ostree-uboot.yaml  | 4 ++++
 3 files changed, 9 insertions(+)

diff --git a/apertis-sample-image-basesdk.yaml b/apertis-sample-image-basesdk.yaml
index dfbee768..71b746a1 100644
--- a/apertis-sample-image-basesdk.yaml
+++ b/apertis-sample-image-basesdk.yaml
@@ -11,6 +11,7 @@
 architecture: {{ $architecture }}
 
 actions:
+  # Create DevRoot ospack to be included in the Base SDK image
   - action: recipe
     description: Create devroot ospack for {{ $devroot_arch }}
     recipe: apertis-ospack-devroot.yaml
@@ -22,11 +23,13 @@ actions:
       timestamp: {{ $timestamp }}
       ospack: {{ $devpack }}
 
+  # Reset the rootfs from previous action to start Base SDK build from a clean rootfs
   - action: run
     description: Reset rootfs
     chroot: false
     command: find ${ROOTDIR} -maxdepth 1 -mindepth 1 -exec rm -rf {} \;
 
+  # Create base rootfs for the Base SDK
   - action: recipe
     description: Create ospack for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-ospack-{{ $type }}.yaml
@@ -36,6 +39,7 @@ actions:
       suite: {{ $suite }}
       timestamp: {{ $timestamp }}
 
+  # Create the Base SDK image based on OSTree rootfs created during previous action
   - action: recipe
     description: Create image {{ $image }} for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-image-sdk.yaml
diff --git a/apertis-sample-image-mx6qsabrelite.yaml b/apertis-sample-image-mx6qsabrelite.yaml
index 0174c579..9dd74e5f 100644
--- a/apertis-sample-image-mx6qsabrelite.yaml
+++ b/apertis-sample-image-mx6qsabrelite.yaml
@@ -17,6 +17,7 @@ actions:
       suite: {{ $suite }}
       timestamp: {{ $timestamp }}
 
+  # Create the MX6 SabreLite image based on rootfs created during previous action 
   - action: recipe
     description: Create image {{ $image }} for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-image-mx6qsabrelite.yaml
diff --git a/apertis-sample-image-ostree-uboot.yaml b/apertis-sample-image-ostree-uboot.yaml
index f6723e5f..453044d4 100644
--- a/apertis-sample-image-ostree-uboot.yaml
+++ b/apertis-sample-image-ostree-uboot.yaml
@@ -19,6 +19,7 @@ actions:
     chroot: false
     command: ostree init --mode archive --repo=${ARTIFACTDIR}/{{ $ostree }}
 
+  # Create base rootfs
   - action: recipe
     description: Create ospack for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-ospack-{{ $type }}.yaml
@@ -28,6 +29,7 @@ actions:
       suite: {{ $suite }}
       timestamp: {{ $timestamp }}
 
+  # Adapt and commit OSTree based on rootfs created during previous action
   - action: recipe
     description: OSTree commit for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-ostree-commit.yaml
@@ -39,11 +41,13 @@ actions:
       branch: {{ $branch }}
       ostree: {{ $ostree }}
 
+  # Reset the rootfs to allow to deploy OSTree from a clean rootfs
   - action: run
     description: Reset rootfs before deploying OSTree
     chroot: false
     command: find ${ROOTDIR} -maxdepth 1 -mindepth 1 -exec rm -rf {} \;
 
+  # Create the U-Boot image based on OSTree rootfs created during previous action 
   - action: recipe
     description: Create image {{ $image }} for {{ $suite }} {{ $type }} {{ $architecture }}
     recipe: apertis-ostree-image-uboot.yaml
-- 
GitLab