[libcamera-devel,v1] libcamera: v4l2_subdev: update struct description

10445 diff mbox series

The described documents were moved from 4.15 -> 4.13.

s/the fourcc code that identify the format/the fourcc code that identifies the format/

Signed-off-by: Sebastian Fricke <sebastian.fricke.linux@gmail.com>
---
 src/libcamera/v4l2_subdevice.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Hi Sebastian,

On 18/11/2020 11:26, Sebastian Fricke wrote:
> The described documents were moved from 4.15 -> 4.13.

I wonder if there's a better way for us to link to those references
without them always becoming stale. Most likely not - they'll always
have updates, and there's no permalink style urls.

> s/the fourcc code that identify the format/the fourcc code that identifies the format/
> 
> Signed-off-by: Sebastian Fricke <sebastian.fricke.linux@gmail.com>

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  src/libcamera/v4l2_subdevice.cpp | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp
> index 85d00c2..0860c28 100644
> --- a/src/libcamera/v4l2_subdevice.cpp
> +++ b/src/libcamera/v4l2_subdevice.cpp
> @@ -141,11 +141,11 @@ const std::map<uint32_t, V4L2SubdeviceFormatInfo> formatInfoMap = {
>   * The format of images when transported on physical interconnections is known
>   * as the "media bus format", and it is identified by a resolution and a pixel
>   * format identification code, known as the "media bus code", not to be confused
> - * with the fourcc code that identify the format of images when stored in memory
> + * with the fourcc code that identifies the format of images when stored in memory
>   * (see V4L2VideoDevice::V4L2DeviceFormat).
>   *
>   * Media Bus formats supported by the V4L2 APIs are described in Section
> - * 4.15.3.4.1 of the "Part I - Video for Linux API" chapter of the "Linux Media
> + * 4.13.3.4.1 of the "Part I - Video for Linux API" chapter of the "Linux Media
>   * Infrastructure userspace API", part of the Linux kernel documentation.
>   *
>   * Image media bus formats are properties of the subdev pads.  When images are
> @@ -154,7 +154,7 @@ const std::map<uint32_t, V4L2SubdeviceFormatInfo> formatInfoMap = {
>   * underlying driver format matching criteria) in order to prepare for a
>   * successful streaming operation. For a more detailed description of the image
>   * format negotiation process when performed between V4L2 subdevices, refer to
> - * Section 4.15.3.1 of the above mentioned Linux kernel documentation section.
> + * Section 4.13.3.1 of the above mentioned Linux kernel documentation section.
>   */
>  
>  /**
>

On 18/11/2020 11:42, Kieran Bingham wrote:
> Hi Sebastian,
> 
> On 18/11/2020 11:26, Sebastian Fricke wrote:
>> The described documents were moved from 4.15 -> 4.13.
> 
> I wonder if there's a better way for us to link to those references
> without them always becoming stale. Most likely not - they'll always
> have updates, and there's no permalink style urls.

Actually, I'm not sure that was correct.


4.13.3.1 links to:
https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/dev-subdev.html#format-negotiation

while 4.13.3.4.1 links to:
https://www.kernel.org/doc/html/latest/userspace-api/media/v4l/subdev-formats.html


That has changed url in the (recent) past, but it's not tied to the
section number.

I wonder if we should provide URLs directly...

We can automate the checking/validity of those URLs if they are
referenced in doxygen, as it has a url-checker built in.

--
Kieran


> 
>> s/the fourcc code that identify the format/the fourcc code that identifies the format/
>>
>> Signed-off-by: Sebastian Fricke <sebastian.fricke.linux@gmail.com>
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
>> ---
>>  src/libcamera/v4l2_subdevice.cpp | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp
>> index 85d00c2..0860c28 100644
>> --- a/src/libcamera/v4l2_subdevice.cpp
>> +++ b/src/libcamera/v4l2_subdevice.cpp
>> @@ -141,11 +141,11 @@ const std::map<uint32_t, V4L2SubdeviceFormatInfo> formatInfoMap = {
>>   * The format of images when transported on physical interconnections is known
>>   * as the "media bus format", and it is identified by a resolution and a pixel
>>   * format identification code, known as the "media bus code", not to be confused
>> - * with the fourcc code that identify the format of images when stored in memory
>> + * with the fourcc code that identifies the format of images when stored in memory
>>   * (see V4L2VideoDevice::V4L2DeviceFormat).
>>   *
>>   * Media Bus formats supported by the V4L2 APIs are described in Section
>> - * 4.15.3.4.1 of the "Part I - Video for Linux API" chapter of the "Linux Media
>> + * 4.13.3.4.1 of the "Part I - Video for Linux API" chapter of the "Linux Media
>>   * Infrastructure userspace API", part of the Linux kernel documentation.
>>   *
>>   * Image media bus formats are properties of the subdev pads.  When images are
>> @@ -154,7 +154,7 @@ const std::map<uint32_t, V4L2SubdeviceFormatInfo> formatInfoMap = {
>>   * underlying driver format matching criteria) in order to prepare for a
>>   * successful streaming operation. For a more detailed description of the image
>>   * format negotiation process when performed between V4L2 subdevices, refer to
>> - * Section 4.15.3.1 of the above mentioned Linux kernel documentation section.
>> + * Section 4.13.3.1 of the above mentioned Linux kernel documentation section.
>>   */
>>  
>>  /**
>>
>