bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: migration-guide-4.2: improve formatting of video-related notes

Browse Source 
Use :c:func:`xxx` and :c:enum:`xxx` instead of plain ``xxx`` when it is
possible.

Signed-off-by: Josuah Demangeon <me@josuah.net>
This commit is contained in:
Josuah Demangeon 2025-06-28 11:49:44 +00:00 committed by Daniel DeGrasse
parent d4914965d8
commit cce8e488d1
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/releases/migration-guide-4.2.rst
View File

@ -702,10 +702,10 @@ Video
* 8 bit RAW Bayer formats BGGR8 / GBRG8 / GRBG8 / RGGB8 have been renamed by adding
a S prefix in front:
``VIDEO_PIX_FMT_BGGR8`` becomes ``VIDEO_PIX_FMT_SBGGR8``
``VIDEO_PIX_FMT_GBRG8`` becomes ``VIDEO_PIX_FMT_SGBRG8``
``VIDEO_PIX_FMT_GRBG8`` becomes ``VIDEO_PIX_FMT_SGRBG8``
``VIDEO_PIX_FMT_RGGB8`` becomes ``VIDEO_PIX_FMT_SRGGB8``
``VIDEO_PIX_FMT_BGGR8`` becomes :c:macro:`VIDEO_PIX_FMT_SBGGR8`
``VIDEO_PIX_FMT_GBRG8`` becomes :c:macro:`VIDEO_PIX_FMT_SGBRG8`
``VIDEO_PIX_FMT_GRBG8`` becomes :c:macro:`VIDEO_PIX_FMT_SGRBG8`
``VIDEO_PIX_FMT_RGGB8`` becomes :c:macro:`VIDEO_PIX_FMT_SRGGB8`
* On STM32 devices, the DCMI driver (:dtcompatible:`st,stm32-dcmi`) now relies on endpoint based
video-interfaces.yaml bindings for sensor interface properties (such as bus width and
@ -714,13 +714,10 @@ Video
:c:func:`video_set_frmival`.
See (:github:`89627`).
* video_endpoint_id enum has been dropped. It is no longer a parameter in any video API.
* :c:enum:`video_endpoint_id` has been dropped. It is no longer a parameter in any video API.
* video_buf_type enum has been added. It is a required parameter in the following video APIs:
``set_stream``
``video_stream_start``
``video_stream_stop``
* :c:enum:`video_buf_type` has been added. It is a required parameter in the following video APIs:
:c:func:`set_stream`, :c:func:`video_stream_start`, :c:func:`video_stream_stop`
* ``video_format.pitch`` has been updated to be set explicitly by the driver, a task formerly
required by the application. This update enables the application to correctly allocate a buffer