Skip to content

Commit

Permalink
west.yml: allow users to easily add more modules
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
mbolivar-nordic authored and carlescufi committed Oct 7, 2021
1 parent e836668 commit 51f8588
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions submanifests/README.txt
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions submanifests/example.yaml.sample
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions west.yml
Original file line number Diff line number Diff line change
Expand Up @@ -219,3 +219,4 @@ manifest:
self:
path: zephyr
west-commands: scripts/west-commands.yml
import: submanifests

0 comments on commit 51f8588

Please sign in to comment.