From d78dd539377b2947e73336f45afb5f1c4812bf9d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Eil=C3=ADs=20N=C3=AD=20Fhlannag=C3=A1in?=
 <elizabeth.flanagan@huawei.com>
Date: Wed, 19 Jan 2022 15:29:59 +0000
Subject: [PATCH] README.txt: Document generate-zephyr-machine use
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit just adds some documentation on how to use the machine
generation recipe.

Signed-off-by: Eilís Ní Fhlannagáin <elizabeth.flanagan@huawei.com>
Signed-off-by: Naveen Saini <naveen.kumar.saini@intel.com>
---
 README.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.txt b/README.txt
index f3dda51..ec860fd 100644
--- a/README.txt
+++ b/README.txt
@@ -105,6 +105,22 @@ or
     $ MACHINE=qemu-nios2 bitbake zephyr-kernel-test-all -c testimage
         
 
+Generating OE Machines based on Zephyr board definitions
+========================================================
+We currently have a recipe called generate-zephry-machines which will go through
+and attempt to create an OE machine conf file for every board in Zephyr.
+
+This is run via:
+
+MACHINE=qemu-x86 bitbake generate-zephyr-machines
+
+The output is then put in the normal deploy dir. This recipe is really only
+useful for maintainers. There is currently no way to use the Zephyr board 
+definition in a single step build. So if you wish to regenerate those machines,
+you will need to run the above, copy the conf files from the deploy dir to the
+machine conf directory and then run your build. This shouldn't need to happen 
+often.
+
 Contributing
 ============
 
-- 
GitLab