Skip to content

Commit cce8e48

Browse files
josuahdanieldegrasse
authored andcommitted
doc: migration-guide-4.2: improve formatting of video-related notes
Use :c:func:`xxx` and :c:enum:`xxx` instead of plain ``xxx`` when it is possible. Signed-off-by: Josuah Demangeon <[email protected]>
1 parent d491496 commit cce8e48

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

doc/releases/migration-guide-4.2.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -702,10 +702,10 @@ Video
702702
* 8 bit RAW Bayer formats BGGR8 / GBRG8 / GRBG8 / RGGB8 have been renamed by adding
703703
a S prefix in front:
704704

705-
``VIDEO_PIX_FMT_BGGR8`` becomes ``VIDEO_PIX_FMT_SBGGR8``
706-
``VIDEO_PIX_FMT_GBRG8`` becomes ``VIDEO_PIX_FMT_SGBRG8``
707-
``VIDEO_PIX_FMT_GRBG8`` becomes ``VIDEO_PIX_FMT_SGRBG8``
708-
``VIDEO_PIX_FMT_RGGB8`` becomes ``VIDEO_PIX_FMT_SRGGB8``
705+
``VIDEO_PIX_FMT_BGGR8`` becomes :c:macro:`VIDEO_PIX_FMT_SBGGR8`
706+
``VIDEO_PIX_FMT_GBRG8`` becomes :c:macro:`VIDEO_PIX_FMT_SGBRG8`
707+
``VIDEO_PIX_FMT_GRBG8`` becomes :c:macro:`VIDEO_PIX_FMT_SGRBG8`
708+
``VIDEO_PIX_FMT_RGGB8`` becomes :c:macro:`VIDEO_PIX_FMT_SRGGB8`
709709

710710
* On STM32 devices, the DCMI driver (:dtcompatible:`st,stm32-dcmi`) now relies on endpoint based
711711
video-interfaces.yaml bindings for sensor interface properties (such as bus width and
@@ -714,13 +714,10 @@ Video
714714
:c:func:`video_set_frmival`.
715715
See (:github:`89627`).
716716

717-
* video_endpoint_id enum has been dropped. It is no longer a parameter in any video API.
717+
* :c:enum:`video_endpoint_id` has been dropped. It is no longer a parameter in any video API.
718718

719-
* video_buf_type enum has been added. It is a required parameter in the following video APIs:
720-
721-
``set_stream``
722-
``video_stream_start``
723-
``video_stream_stop``
719+
* :c:enum:`video_buf_type` has been added. It is a required parameter in the following video APIs:
720+
:c:func:`set_stream`, :c:func:`video_stream_start`, :c:func:`video_stream_stop`
724721

725722
* ``video_format.pitch`` has been updated to be set explicitly by the driver, a task formerly
726723
required by the application. This update enables the application to correctly allocate a buffer

0 commit comments

Comments
 (0)