Re: [PATCH] media: Fix building pdfdocs

Re: [PATCH] media: Fix building pdfdocs

[Akira Yokosawa]

[+CC: Jon, linux-doc]

On Wed,  8 Feb 2023 10:29:16 +0200, Tomi Valkeinen wrote:
> Commit 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats") added
> documatation for a few new RGB formats. For some reason these break the
> pdfdocs build, even if the same style seems to work elsewhere in the
> file.
> 
> Remove the trailing empty dash lines, which seems to fix the issue.
> 
> Fixes: 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats")
> Reported-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/r/12250823-8445-5854-dfb8-b92c0ff0851e@gmail.com/

> Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> ---
> 
> Note: the offending patch was merged via drm tree, so we may want to
> apply the fix to the drm tree also.

So, the offending commit is now in mainline without this fix...
I believe this build regression -- a real build error of "make pdfdocs"
-- should be fixed ASAP.

Tomi, Laurent has suggested a typo fix in the Changelog.
Can you respin ?

Or, Laurent, can you do the fix on your own?

Hopefully, the fix can make v6.3-rc1.

        Thanks, Akira

> 
>  Documentation/userspace-api/media/v4l/pixfmt-rgb.rst | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> index d330aeb4d3eb..ea545ed1aeaa 100644
> --- a/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> +++ b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> @@ -868,7 +868,6 @@ number of bits for each component.
>        - r\ :sub:`4`
>        - r\ :sub:`3`
>        - r\ :sub:`2`
> -      -
>      * .. _V4L2-PIX-FMT-RGBA1010102:
>  
>        - ``V4L2_PIX_FMT_RGBA1010102``
> @@ -909,7 +908,6 @@ number of bits for each component.
>        - r\ :sub:`4`
>        - r\ :sub:`3`
>        - r\ :sub:`2`
> -      -
>      * .. _V4L2-PIX-FMT-ARGB2101010:
>  
>        - ``V4L2_PIX_FMT_ARGB2101010``
> @@ -950,7 +948,6 @@ number of bits for each component.
>        - r\ :sub:`6`
>        - r\ :sub:`5`
>        - r\ :sub:`4`
> -      -
>  
>  .. raw:: latex
>  

Re: [PATCH] media: Fix building pdfdocs

[Mauro Carvalho Chehab]

Em Sun, 26 Feb 2023 08:39:32 +0900
Akira Yokosawa <akiyks@gmail.com> escreveu:

> [+CC: Jon, linux-doc]
> 
> On Wed,  8 Feb 2023 10:29:16 +0200, Tomi Valkeinen wrote:
> > Commit 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats") added
> > documatation for a few new RGB formats. For some reason these break the
> > pdfdocs build, even if the same style seems to work elsewhere in the
> > file.
> > 
> > Remove the trailing empty dash lines, which seems to fix the issue.
> > 
> > Fixes: 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats")
> > Reported-by: Akira Yokosawa <akiyks@gmail.com>  
> Link: https://lore.kernel.org/r/12250823-8445-5854-dfb8-b92c0ff0851e@gmail.com/
> 
> > Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> > ---
> > 
> > Note: the offending patch was merged via drm tree, so we may want to
> > apply the fix to the drm tree also.  
> 
> So, the offending commit is now in mainline without this fix...
> I believe this build regression -- a real build error of "make pdfdocs"
> -- should be fixed ASAP.
> 
> Tomi, Laurent has suggested a typo fix in the Changelog.
> Can you respin ?
> 
> Or, Laurent, can you do the fix on your own?
> 
> Hopefully, the fix can make v6.3-rc1.

Better to wait for media PR to be handled. There were some changes at
the documentation that affected the patch. I guess the bug is gone.
If not, we'll need to rebase the patch.

Regards,
Mauro

> 
>         Thanks, Akira
> 
> > 
> >  Documentation/userspace-api/media/v4l/pixfmt-rgb.rst | 3 ---
> >  1 file changed, 3 deletions(-)
> > 
> > diff --git a/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> > index d330aeb4d3eb..ea545ed1aeaa 100644
> > --- a/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> > +++ b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst
> > @@ -868,7 +868,6 @@ number of bits for each component.
> >        - r\ :sub:`4`
> >        - r\ :sub:`3`
> >        - r\ :sub:`2`
> > -      -
> >      * .. _V4L2-PIX-FMT-RGBA1010102:
> >  
> >        - ``V4L2_PIX_FMT_RGBA1010102``
> > @@ -909,7 +908,6 @@ number of bits for each component.
> >        - r\ :sub:`4`
> >        - r\ :sub:`3`
> >        - r\ :sub:`2`
> > -      -
> >      * .. _V4L2-PIX-FMT-ARGB2101010:
> >  
> >        - ``V4L2_PIX_FMT_ARGB2101010``
> > @@ -950,7 +948,6 @@ number of bits for each component.
> >        - r\ :sub:`6`
> >        - r\ :sub:`5`
> >        - r\ :sub:`4`
> > -      -
> >  
> >  .. raw:: latex
> >    



Thanks,
Mauro

Re: [PATCH] media: Fix building pdfdocs

[Akira Yokosawa]

Hi Mauro,

On Sun, 26 Feb 2023 11:47:44 +0100, Mauro Carvalho Chehab wrote:
> Em Sun, 26 Feb 2023 08:39:32 +0900
> Akira Yokosawa <akiyks@gmail.com> escreveu:
> 
>> [+CC: Jon, linux-doc]
>>
>> On Wed,  8 Feb 2023 10:29:16 +0200, Tomi Valkeinen wrote:
>>> Commit 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats") added
>>> documatation for a few new RGB formats. For some reason these break the
>>> pdfdocs build, even if the same style seems to work elsewhere in the
>>> file.
>>>
>>> Remove the trailing empty dash lines, which seems to fix the issue.
>>>
>>> Fixes: 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats")
>>> Reported-by: Akira Yokosawa <akiyks@gmail.com>  
>> Link: https://lore.kernel.org/r/12250823-8445-5854-dfb8-b92c0ff0851e@gmail.com/
>>
>>> Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
>>> ---
>>>
>>> Note: the offending patch was merged via drm tree, so we may want to
>>> apply the fix to the drm tree also.  
>>
>> So, the offending commit is now in mainline without this fix...
>> I believe this build regression -- a real build error of "make pdfdocs"
>> -- should be fixed ASAP.
>>
>> Tomi, Laurent has suggested a typo fix in the Changelog.
>> Can you respin ?
>>
>> Or, Laurent, can you do the fix on your own?
>>
>> Hopefully, the fix can make v6.3-rc1.
> 
> Better to wait for media PR to be handled. There were some changes at
> the documentation that affected the patch. I guess the bug is gone.

You mean the PR at https://lore.kernel.org/lkml/20230226114551.68480d44@coco.lan/ ?
Unfortunately, it has had no effect on this issue.

> If not, we'll need to rebase the patch.

There was no change in Documentation/userspace-api/media/v4l/pixfmt-rgb.rst,
so rebase is not needed.

Should this bug survive v6.3-rc1, I guess this fix could go through
media or doc tree.

Thoughts?

        Thanks, Akira

> 
> Regards,
> Mauro
> 

Re: [PATCH] media: Fix building pdfdocs

[Tomi Valkeinen]

On 27/02/2023 14:06, Akira Yokosawa wrote:
> Hi Mauro,
> 
> On Sun, 26 Feb 2023 11:47:44 +0100, Mauro Carvalho Chehab wrote:
>> Em Sun, 26 Feb 2023 08:39:32 +0900
>> Akira Yokosawa <akiyks@gmail.com> escreveu:
>>
>>> [+CC: Jon, linux-doc]
>>>
>>> On Wed,  8 Feb 2023 10:29:16 +0200, Tomi Valkeinen wrote:
>>>> Commit 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats") added
>>>> documatation for a few new RGB formats. For some reason these break the
>>>> pdfdocs build, even if the same style seems to work elsewhere in the
>>>> file.
>>>>
>>>> Remove the trailing empty dash lines, which seems to fix the issue.
>>>>
>>>> Fixes: 8d0e3fc61abd ("media: Add 2-10-10-10 RGB formats")
>>>> Reported-by: Akira Yokosawa <akiyks@gmail.com>
>>> Link: https://lore.kernel.org/r/12250823-8445-5854-dfb8-b92c0ff0851e@gmail.com/
>>>
>>>> Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
>>>> ---
>>>>
>>>> Note: the offending patch was merged via drm tree, so we may want to
>>>> apply the fix to the drm tree also.
>>>
>>> So, the offending commit is now in mainline without this fix...
>>> I believe this build regression -- a real build error of "make pdfdocs"
>>> -- should be fixed ASAP.
>>>
>>> Tomi, Laurent has suggested a typo fix in the Changelog.
>>> Can you respin ?
>>>
>>> Or, Laurent, can you do the fix on your own?
>>>
>>> Hopefully, the fix can make v6.3-rc1.
>>
>> Better to wait for media PR to be handled. There were some changes at
>> the documentation that affected the patch. I guess the bug is gone.
> 
> You mean the PR at https://lore.kernel.org/lkml/20230226114551.68480d44@coco.lan/ ?
> Unfortunately, it has had no effect on this issue.
> 
>> If not, we'll need to rebase the patch.
> 
> There was no change in Documentation/userspace-api/media/v4l/pixfmt-rgb.rst,
> so rebase is not needed.
> 
> Should this bug survive v6.3-rc1, I guess this fix could go through
> media or doc tree.

This patch applies fine on top of current Linus' master.

As this is a media patch, and the offending commit is now in upstream, 
maybe it's better to get this fix in via linux-media rather than linux-drm.

Mauro, can you pick this up?

  Tomi