Skip to content

snippets: added example debugging snippet - #109

Open
whati001 wants to merge 2 commits into
zephyrproject-rtos:mainfrom
whati001:feat/snippets
Open

whati001 wants to merge 2 commits into
zephyrproject-rtos:mainfrom
whati001:feat/snippets

Conversation

@whati001

Copy link
Copy Markdown

Showcase how to add custom snippets by exposing the existing debug Kconfig value as a debug snippet named debugging.

@rettichschnidi

Copy link
Copy Markdown
Contributor

To showcase snippets, I'd rather have an example that does not duplicate existing mechanism (debug.conf). So, either a complete new, distinctive snippet or getting rid of debug.conf.

@whati001

Copy link
Copy Markdown
Author

Personally, I would replace the debug.conf with a debugging snipped.

Andreas Karner and others added 2 commits September 25, 2026 08:15
Showcase how to add custom snippets by exposing the existing debug
Kconfig value as a debug snippet named debugging.

Signed-off-by: Andreas Karner <whati001@outlook.com>
@whati001

Copy link
Copy Markdown
Author

@rettichschnidi made the following changes:

  • Enable debugging via snippet only
  • Enable the logging subsystem via an additional Kconfig fragment

What do you think now?

@henrikbrixandersen

Copy link
Copy Markdown
Member

Not sure we need to "showcase" snippets here? Snippets are pretty well-documented (https://docs.zephyrproject.org/latest/build/snippets/index.html) and there are lots of examples in-tree.

@whati001

whati001 commented Oct 1, 2026

Copy link
Copy Markdown
Author

It’s up to you what you want this repo to showcase, but here’s my train of thought:

Not everyone reads through the entire documentation. Instead, people often start by pulling the repo and exploring what’s actually in it.

At least for me, it took quite a while to realize that the snippets even existed.

Maybe that’s just me, though. And perhaps this has already changed with AI, since it can now surface things you might otherwise overlook.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants