Skip to content

Commit 8aecab3

Browse files
committed
doc: build: snippets: Add sysbuild usage
Adds an example on how to use a snippet with sysbuild Signed-off-by: Jamie McCrae <[email protected]>
1 parent 35e1804 commit 8aecab3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/build/snippets/writing.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ this:
3131
EXTRA_DTC_OVERLAY_FILE: foo.overlay
3232
EXTRA_CONF_FILE: foo.conf
3333
34+
In addition, snippets can also be applied to sysbuild configuration like so:
35+
36+
.. code-block:: yaml
37+
38+
name: foo
39+
append:
40+
SB_EXTRA_CONF_FILE: sb.conf
41+
EXTRA_CONF_FILE: app.conf
42+
3443
Namespacing
3544
***********
3645

@@ -156,6 +165,20 @@ This :file:`snippet.yml` adds :file:`foo.conf` to the build:
156165
The path to :file:`foo.conf` is relative to the directory containing
157166
:file:`snippet.yml`.
158167

168+
Sysbuild ``.conf`` files
169+
************************
170+
171+
This :file:`snippet.yml` adds :file:`foo.conf` to the sysbuild configuration:
172+
173+
.. code-block:: yaml
174+
175+
name: foo
176+
append:
177+
SB_EXTRA_CONF_FILE: foo.conf
178+
179+
The path to :file:`foo.conf` is relative to the directory containing
180+
:file:`snippet.yml`.
181+
159182
``DTS_EXTRA_CPPFLAGS``
160183
**********************
161184

0 commit comments

Comments
 (0)