Skip to content

drivers: video: samples: improve the video-sw-generator doc #90937

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

Merged

Conversation

josuah
Copy link
Collaborator

@josuah josuah commented Jun 2, 2025

After #88780 got merged, the video-sw-generator requires new command line flags to build.
This can be misleading and some confusion can be avoided as proposed through these commits:

  • samples: drivers: video: add DT_HAS_CHOSEN() safeguards
  • samples: drivers: video: capture: remove invalid build instruction
  • doc: release: mention new video-sw-generator snippet

@josuah josuah added area: Samples Samples area: native port Host native arch port (native_sim) Release Notes To be mentioned in the release notes area: Video Video subsystem labels Jun 2, 2025
@josuah
Copy link
Collaborator Author

josuah commented Jun 2, 2025

The usability of video devices might further be improved by #88182 which gives a list of all video devices accessible to users: those capable of I/O.

@josuah josuah force-pushed the pr-video-samples-doc branch from 13966f1 to 438c39f Compare June 2, 2025 11:25
@josuah josuah marked this pull request as ready for review June 2, 2025 12:08
@dkalowsk
Copy link
Collaborator

@josuah can you rebase this please for RC2?

@dkalowsk dkalowsk added this to the v4.2.0 milestone Jun 28, 2025
josuah added 3 commits June 28, 2025 09:32
Add macros giving hints to users using #error, about what might be
missing to build and run the samples, such as a missing "chosen"
devicetree node.

Signed-off-by: Josuah Demangeon <me@josuah.net>
Remove the build instruction from README about using the native_sim
without using the video-sw-generator snippet, as it cannot build.

Signed-off-by: Josuah Demangeon <me@josuah.net>
This snippet got introduced, and is not a breaking change for C APIs but
still introduce a change of command line to use for building projects,
so add a migration guide entry.

Signed-off-by: Josuah Demangeon <me@josuah.net>
@josuah josuah force-pushed the pr-video-samples-doc branch from 438c39f to 893ff22 Compare June 28, 2025 09:39
Copy link

Copy link
Collaborator

@ngphibang ngphibang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@avolmat-st avolmat-st left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks.

@danieldegrasse danieldegrasse merged commit e23f12d into zephyrproject-rtos:main Jun 30, 2025
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: native port Host native arch port (native_sim) area: Samples Samples area: Video Video subsystem Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants