Skip to content

Commit 51f8588

Browse files
mbolivar-nordiccarlescufi
authored andcommitted
west.yml: allow users to easily add more modules
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 <[email protected]>
1 parent e836668 commit 51f8588

File tree

4 files changed

+30
-0
lines changed

4 files changed

+30
-0
lines changed

CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
/soc/arm64/xenvm/ @lorc
6363
/soc/arm64/arm/ @povergoing
6464
/soc/arm64/arm/fvp_aemv8a/ @carlocaione
65+
/submanifests/* @mbolivar-nordic
6566
/arch/x86/ @jhedberg @nashif @jenmwms @aasthagr
6667
/arch/nios2/ @nashif
6768
/arch/posix/ @aescolar @daor-oti

submanifests/README.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
This directory can contain additional west manifest files. Any files
2+
in this directory will be included in the main west.yml file sorted by
3+
filename.
4+
5+
See example.yaml.sample for an example.
6+
7+
For more details about how this works, see this part of the west
8+
documentation:
9+
10+
https://docs.zephyrproject.org/latest/guides/west/manifest.html#example-2-2-downstream-with-directory-of-manifest-files

submanifests/example.yaml.sample

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Example manifest file you can include into the main west.yml file.
2+
#
3+
# To make this work, copy this file's contents to a new file,
4+
# 'example.yaml', in the same directory.
5+
#
6+
# Then change the 'name' and 'url' below and run 'west update'.
7+
#
8+
# Your module will be added to the local workspace and kept in sync
9+
# every time you run 'west update'.
10+
#
11+
# If you want to fetch a particular commit rather than the main
12+
# branch, change the 'revision' line accordingly.
13+
14+
manifest:
15+
projects:
16+
- name: my-module
17+
url: https://github.com/my-username/my-module
18+
revision: main

west.yml

+1
Original file line numberDiff line numberDiff line change
@@ -219,3 +219,4 @@ manifest:
219219
self:
220220
path: zephyr
221221
west-commands: scripts/west-commands.yml
222+
import: submanifests

0 commit comments

Comments
 (0)