Re: [yocto-patches] [meta-zephyr][master][PATCH 08/12] meta-zephyr: Update README files

["Gundlupet Raju, Sandeep" <sandeep.gundlupet-raju@amd.com>]

Hi Chee Yang,

This patch is missing in master. Can you please merge it.

Thanks,
Sandeep

On 8/14/2025 9:54 PM, Sandeep Gundlupet Raju via lists.yoctoproject.org 
wrote:
> Update README files with following.
>
>   - Build instructions
>   - Maintainers lists and patch submission
>
> Signed-off-by: Sandeep Gundlupet Raju <sandeep.gundlupet-raju@amd.com>
> ---
>   README.txt => README.md     | 163 ++++++++++++++++++++++++------------
>   meta-zephyr-bsp/README.md   |   5 ++
>   meta-zephyr-bsp/README.txt  |   1 -
>   meta-zephyr-core/README.md  |   6 ++
>   meta-zephyr-core/README.txt |   1 -
>   5 files changed, 120 insertions(+), 56 deletions(-)
>   rename README.txt => README.md (60%)
>   create mode 100644 meta-zephyr-bsp/README.md
>   delete mode 100644 meta-zephyr-bsp/README.txt
>   create mode 100644 meta-zephyr-core/README.md
>   delete mode 100644 meta-zephyr-core/README.txt
>
> diff --git a/README.txt b/README.md
> similarity index 60%
> rename from README.txt
> rename to README.md
> index 247c029..e38138a 100644
> --- a/README.txt
> +++ b/README.md
> @@ -1,71 +1,101 @@
> -Building Zephyr Images via bitbake recipes
> -==========================================
> +# meta-zephyr
>   
> -More detailed and up-to-date information can be found here:
> -
> -https://wiki.yoctoproject.org/wiki/TipsAndTricks/BuildingZephyrImages
> +This layer enables building Zephyr using Yocto Project.
>   
> -Prerequisites:
> -==============
> +## Dependencies
>   
>   This layer depends on:
> -    Yocto distro (master)
> -        git://git.yoctoproject.org/poky
> -    Python layer (meta-openembedded/meta-python)
> -        git://git.openembedded.org/meta-openembedded
>   
> -Add "meta-openembedded/meta-oe" to BBLAYERS
> -Add "meta-openembedded/meta-python" to BBLAYERS
> -Add "meta-zephyr-core" and "meta-zephyr-bsp" to BBLAYERS
> +	URI: https://git.yoctoproject.org/poky
> +	layers: meta, meta-poky
> +	branch: scarthgap
> +
> +	URI: https://git.openembedded.org/meta-openembedded
> +	layers: meta-oe, meta-python
> +	branch: scarthgap
> +
> +## Building Zephyr Images via bitbake recipes
> +
> +More detailed and up-to-date information can be found here:
> +
> +https://wiki.yoctoproject.org/wiki/TipsAndTricks/BuildingZephyrImages
>   
> -Building and Running Zephyr Samples
> -===================================
> +> **Pre-requisites:**
> +1. Refer [Yocto Project Quick Build]( https://docs.yoctoproject.org/dev/singleindex.html#yocto-project-quick-build) documentation.
> +
> +2. Clone and add following layers to BBLAYERS
> +    * meta-openembedded/meta-oe
> +    * meta-openembedded/meta-python
> +    * meta-zephyr-core
> +    * meta-zephyr-bsp
> +```
> +    $ mkdir sources
> +    $ git clone -b <release-branch> https://git.yoctoproject.org/poky
> +    $ git clone -b <branch-name> https://git.openembedded.org/meta-openembedded
> +    $ git clone -b <branch-name> https://git.yoctoproject.org/meta-zephyr
> +    $ source poky/oe-init-build-env
> +    $ bitbake-layers add-layer ../meta-openembedded/meta-oe
> +    $ bitbake-layers add-layer ../meta-openembedded/meta-python
> +    $ bitbake-layers add-layer ../meta-zephyr/meta-zephyr-core
> +    $ bitbake-layers add-layer ../meta-zephyr/meta-zephyr-bsp
> +```
> +
> +### Building and Running Zephyr Samples
>   
>   You can build Zephyr samples. There are several sample recipes.
>   
>   To use the Yocto toolchain, modify local conf by adding:
> +```
>       DISTRO = "zephyr"
> +```
>   
>   To use the Zephyr pre-built toolchain, modify local conf by adding:
> +```
>       ZEPHYR_TOOLCHAIN_VARIANT = "zephyr"
> +```
>   
>   For example, to build the Zephyr "philosophers" sample:
> -
> +```
>       $ MACHINE=qemu-x86 bitbake zephyr-philosophers
> -
> -You can then run the created "philosophers" image in qemu:
> +```
>   
> +You can then run the created "philosophers" image in qemu:
> +```
>       $ runqemu qemu-x86
> -
> -The same sample, for ARM image:
> +```
>   
> +The same sample, for ARM image:
> +```
>       $ MACHINE=qemu-cortex-m3 bitbake zephyr-philosophers
>       $ runqemu qemu-cortex-m3
> -
> -The same sample, for Nios2 image:
> +```
>   
> +The same sample, for Nios2 image:
> +```
>       $ MACHINE=qemu-nios2 bitbake zephyr-philosophers
>       $ runqemu qemu-nios2
> +```
>   
> -Flashing
> -=================================
> +### Flashing
>   
>   You can flash Zephyr samples to boards. Currently, the following MACHINEs
>   are supported:
>    * DFU:
> -  - arduino-101-sss
> -  - arduino-101
> -  - arduino-101-ble
> +   * arduino-101-sss
> +   * arduino-101
> +   * arduino-101-ble
>    * pyocd:
> -  - 96b-nitrogen
> +   * 96b-nitrogen
>   
>   To flash the example you built with command e.g.
> -
> +```
>       $ MACHINE=96b-nitrogen bitbake zephyr-philosophers
> +```
>   
>   call similar command with explicit flash_usb command:
> -
> +```
>       $ MACHINE=96b-nitrogen bitbake zephyr-philosophers -c flash_usb
> +```
>   
>   dfu-util and/or pyocd need to be installed in your system. If you observe
>   permission errors or the flashing process seem to hang, follow those instructions:
> @@ -77,28 +107,31 @@ of IDs. Once that is set, the tool will only try to program these IDs. You can
>   query for the IDs by running `pyocd list` on your host while having the probes
>   attached. Besides setting this variable through the build's configuration or
>   metadata, you can also inject its value from command line with something like:
> -
> +```
>       $ PYOCD_FLASH_IDS='<ID1> <ID2> <ID3>' BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE PYOCD_FLASH_IDS" bitbake <TARGET> -c flash_usb
> +```
> +
> +## Building and Running Zephyr Tests
>   
> -Building and Running Zephyr Tests
> -=================================
>   Presently only toolchains for ARM, x86, IAMCU and Nios2 are supported.
>   (For ARM we use CortexM3 toolchain)
>   
>   To run Zephyr Test using Yocto Image Tests, ensure following in local.conf:
> -
> +```
>       INHERIT += "testimage"
> +```
>   
>   You can build and test an individual existing Zephyr test.
>   This is done by appending the actual test name to the "zephyr-kernel-test",
>   for example:
> -
> +```
>       $ MACHINE=qemu-x86 bitbake zephyr-kernel-test-sleep
>       $ MACHINE=qemu-x86 bitbake zephyr-kernel-test-sleep -c testimage
> +```
>   
>   You can also build and run all Zephyr existing tests (as listed in the file
>   zephyr-kernel-test.inc). For example:
> -
> +```
>       $ MACHINE=qemu-x86 bitbake zephyr-kernel-test-all
>       $ MACHINE=qemu-x86 bitbake zephyr-kernel-test-all -c testimage
>   or
> @@ -107,16 +140,17 @@ or
>   or
>       $ MACHINE=qemu-nios2 bitbake zephyr-kernel-test-all
>       $ MACHINE=qemu-nios2 bitbake zephyr-kernel-test-all -c testimage
> -
> +```
> +
> +## Generating OE Machines based on Zephyr board definitions
>   
> -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
> @@ -125,14 +159,15 @@ 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.
>   
> -Generating new Zephyr recipe versions
> -=====================================
> +## Generating new Zephyr recipe versions
> +
>   The script meta-zephyr-core/scripts/generate-version.py is used to generate
>   Yocto configuration for a Zephyr version from the West configuration in the
>   Zephyr repository. It requires the west and jinja2 Python packages to be
>   installed on the host. Run it as follows:
> -
> +```
>       $ ./meta-zephyr-core/scripts/generate-version.py x.x.x
> +```
>   
>   where x.x.x is the Zephyr version.
>   
> @@ -140,17 +175,37 @@ The patch files added to SRC_URI in the generated file should be validated and
>   modified if required.
>   
>   The new version should be committed and submitted to the mailing list as
> -described in "Contributing".
> +described in "Maintainers, Mailing list, Patches".
> +
> +## Maintainers, Mailing list, Patches
> +
> +Please send any patches for this layer to the yocto-patches mailinglists
> +with ['meta-zephyr'] in the subject:
> +
> +	yocto-patches@lists.yoctoproject.org
> +
> +When sending patches, please make sure the email subject line includes
> +`[meta-amd-edf][<BRANCH_NAME>][PATCH]` and cc'ing the maintainers.
> +
> +For more details follow the Yocto Project community patch submission guidelines,
> +as described in:
> +
> +https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html#
> +
> +`git send-email --to yocto-patches@lists.yoctoproject.org *.patch`
> +
> +> **Note:** When creating patches, please use below format. To follow best practice,
> +> if you have more than one patch use `--cover-letter` option while generating the
> +> patches. Edit the 0000-cover-letter.patch and change the title and top of the
> +> body as appropriate.
>   
> -Contributing
> -============
> +**Syntax:**
> +`git format-patch -s --subject-prefix="meta-zephyr][<BRANCH_NAME>][PATCH" -1`
>   
> -Patches for meta-zephyr should be sent to the yocto-patches@lists.yoctoproject.org
> -mailing list.  See https://lists.yoctoproject.org/g/yocto-patches for subscription
> -details and the list archive.  Please add [meta-zephyr] to the subject so
> -the patches are identifable.
> +**Example:**
> +`git format-patch -s --subject-prefix="meta-zephyr][scarthgap][PATCH" -1`
>   
> -Git can be configured to send mails appropriately when using git send-email:
> +**Maintainers:**
>   
> -$ git config --local sendemail.to yocto-patches@lists.yoctoproject.org
> -$ git config --local format.subjectPrefix meta-zephyr][PATCH
> +    Lee Chee Yang <chee.yang.lee@intel.com>
> +	Sandeep Gundlupet Raju <sandeep.gundlupet-raju@amd.com>
> diff --git a/meta-zephyr-bsp/README.md b/meta-zephyr-bsp/README.md
> new file mode 100644
> index 0000000..e159015
> --- /dev/null
> +++ b/meta-zephyr-bsp/README.md
> @@ -0,0 +1,5 @@
> +# meta-zephyr-bsp
> +
> +This layer contains machine files for building Zephyr applications.
> +
> +For more details see [Building Instructions](../README.md)
> diff --git a/meta-zephyr-bsp/README.txt b/meta-zephyr-bsp/README.txt
> deleted file mode 100644
> index 2644ed0..0000000
> --- a/meta-zephyr-bsp/README.txt
> +++ /dev/null
> @@ -1 +0,0 @@
> -See ../README.txt
> diff --git a/meta-zephyr-core/README.md b/meta-zephyr-core/README.md
> new file mode 100644
> index 0000000..18db977
> --- /dev/null
> +++ b/meta-zephyr-core/README.md
> @@ -0,0 +1,6 @@
> +# meta-zephyr-core
> +
> +This layer enables Zephyr build metadata such as zephyr scripts, kernel include
> +files, zephyr applications recipes and bitbake class to support qemu boot.
> +
> +For more details see [Building Instructions](../README.md)
> diff --git a/meta-zephyr-core/README.txt b/meta-zephyr-core/README.txt
> deleted file mode 100644
> index 2644ed0..0000000
> --- a/meta-zephyr-core/README.txt
> +++ /dev/null
> @@ -1 +0,0 @@
> -See ../README.txt