From 51f8588fb8978e6be4708ca414832df57dd5e73a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Thu, 22 Jul 2021 17:29:15 -0700 Subject: [PATCH] west.yml: allow users to easily add more modules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Import any manifest files in a new 'submanifests' directory into west.yml. This lets users define custom zephyr modules or easily override built-in modules by dropping their own manifest files into submanifests/some-user-file.yaml. Provide an example and a README with links to the relevant documentation in 'submanifests' to get users started. Signed-off-by: Martí Bolívar --- CODEOWNERS | 1 + submanifests/README.txt | 10 ++++++++++ submanifests/example.yaml.sample | 18 ++++++++++++++++++ west.yml | 1 + 4 files changed, 30 insertions(+) create mode 100644 submanifests/README.txt create mode 100644 submanifests/example.yaml.sample diff --git a/CODEOWNERS b/CODEOWNERS index 291c1e8af1..d60f4b122b 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -62,6 +62,7 @@ /soc/arm64/xenvm/ @lorc /soc/arm64/arm/ @povergoing /soc/arm64/arm/fvp_aemv8a/ @carlocaione +/submanifests/* @mbolivar-nordic /arch/x86/ @jhedberg @nashif @jenmwms @aasthagr /arch/nios2/ @nashif /arch/posix/ @aescolar @daor-oti diff --git a/submanifests/README.txt b/submanifests/README.txt new file mode 100644 index 0000000000..75f4e0d6d4 --- /dev/null +++ b/submanifests/README.txt @@ -0,0 +1,10 @@ +This directory can contain additional west manifest files. Any files +in this directory will be included in the main west.yml file sorted by +filename. + +See example.yaml.sample for an example. + +For more details about how this works, see this part of the west +documentation: + +https://docs.zephyrproject.org/latest/guides/west/manifest.html#example-2-2-downstream-with-directory-of-manifest-files diff --git a/submanifests/example.yaml.sample b/submanifests/example.yaml.sample new file mode 100644 index 0000000000..49f903d26e --- /dev/null +++ b/submanifests/example.yaml.sample @@ -0,0 +1,18 @@ +# Example manifest file you can include into the main west.yml file. +# +# To make this work, copy this file's contents to a new file, +# 'example.yaml', in the same directory. +# +# Then change the 'name' and 'url' below and run 'west update'. +# +# Your module will be added to the local workspace and kept in sync +# every time you run 'west update'. +# +# If you want to fetch a particular commit rather than the main +# branch, change the 'revision' line accordingly. + +manifest: + projects: + - name: my-module + url: https://github.com/my-username/my-module + revision: main diff --git a/west.yml b/west.yml index 7baa73d6c9..9fe328fb68 100644 --- a/west.yml +++ b/west.yml @@ -219,3 +219,4 @@ manifest: self: path: zephyr west-commands: scripts/west-commands.yml + import: submanifests