Skip to content

snippets: Organize snippets based on generality and vendors specific snippets #93332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/build/snippets/writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The build system looks for snippets in these places:

#. In directories configured by the :makevar:`SNIPPET_ROOT` CMake variable.
This always includes the zephyr repository (so
:zephyr_file:`snippets/` is always a source of snippets) and the
:zephyr_file:`snippets/generic/` is always a source of snippets) and the
application source directory (so :file:`<app>/snippets` is also).

Additional directories can be added manually at CMake time.
Expand Down
8 changes: 4 additions & 4 deletions doc/services/shell/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ to your build:

Details on the configuration settings are captured in the following files:

- :zephyr_file:`snippets/cdc-acm-console/cdc-acm-console.conf`.
- :zephyr_file:`snippets/cdc-acm-console/cdc-acm-console.overlay`.
- :zephyr_file:`snippets/generic/cdc-acm-console/cdc-acm-console.conf`.
- :zephyr_file:`snippets/generic/cdc-acm-console/cdc-acm-console.overlay`.

Bluetooth LE (NUS)
==================
Expand All @@ -107,8 +107,8 @@ to your build:

Details on the configuration settings are captured in the following files:

- :zephyr_file:`snippets/nus-console/nus-console.conf`.
- :zephyr_file:`snippets/nus-console/nus-console.overlay`.
- :zephyr_file:`snippets/generic/nus-console/nus-console.conf`.
- :zephyr_file:`snippets/generic/nus-console/nus-console.overlay`.

Segger RTT
==========
Expand Down
2 changes: 1 addition & 1 deletion scripts/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def parse_args():
parser.add_argument('--snippet', dest='snippets', default=[], action='append',
help='''a SNIPPET element; may be given
multiple times''')
parser.add_argument('--cmake-out', type=Path,
parser.add_argument('--cmake-out', type=Path, required=True,
help='''file to write cmake output to; include()
this file after calling this script''')
parser.add_argument('--sysbuild', action="store_true",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For example:
QEMU example with Xen
***********************

Overlay for qemu_cortex_a53 board, that is present in :zephyr_file:`snippets/xen_dom0/boards/`
Overlay for qemu_cortex_a53 board, that is present in :zephyr_file:`snippets/generic/xen_dom0/boards/`
directory of this snippet is QEMU Xen control domain example.

To run such setup, you need to:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading