doc: releases: 4.1: add notes/migration guide for video CID rename

The video CIDs got changed, and users will be impacted and need to rename some constants. Offer a strategy for finding the new names in the migration guide for the upcoming release. Signed-off-by: Josuah Demangeon <[email protected]>
zephyrproject-rtos · Nov 27, 2024 · 5be4aed · 5be4aed
1 parent 8c226b9
commit 5be4aed
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/releases/migration-guide-4.1.rst b/doc/releases/migration-guide-4.1.rst
@@ -122,6 +122,16 @@ Stepper
 Regulator
 =========
 
+Video
+=====
+
+* The :file:`include/zephyr/drivers/video-controls.h` got updated to have video controls IDs (CIDs)
+  matching the definitions in the Linux kernel file ``include/uapi/linux/v4l2-controls.h``.
+  In most cases, removing the category prefix is enough: ``VIDEO_CID_CAMERA_GAIN`` becomes
+  ``VIDEO_CID_GAIN``.
+  The new ``video-controls.h`` source now contains description of each control ID to help
+  disambiguating.
+
 Bluetooth
 *********
 

diff --git a/doc/releases/release-notes-4.1.rst b/doc/releases/release-notes-4.1.rst
@@ -191,6 +191,9 @@ Drivers and Sensors
 
 * Video
 
+  * Changed :file:`include/zephyr/drivers/video-controls.h` to have control IDs (CIDs) matching
+    those present in the Linux kernel.
+
 * Watchdog
 
 * Wi-Fi
-Original file line number
+Diff line change
@@ Expand Up / @@ -191,6 +191,9 @@ Drivers and Sensors @@
     * Video
+      * Changed :file:`include/zephyr/drivers/video-controls.h` to have control IDs (CIDs) matching
+        those present in the Linux kernel.
     * Watchdog
     * Wi-Fi
@@ Expand Down @@