[PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()

Sukrut Heroorkar posted 1 patch 2 months ago
drivers/gpu/drm/drm_bridge.c | 1 +
1 file changed, 1 insertion(+)
[PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()
Posted by Sukrut Heroorkar 2 months ago
drm: drm_bridge: fix missing parameter documentation

The function documentation was missing description for the
parameter 'connector'.

Add missing function parameter documentation for drm_bridge_detect()
to fix kernel-doc warnings.

Warning: drivers/gpu/drm/drm_bridge.c:1241 function parameter 'connector' not described in 'drm_bridge_detect'

Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
---
 drivers/gpu/drm/drm_bridge.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index dd45d9b504d8..387a3b6cda54 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -1227,6 +1227,7 @@ EXPORT_SYMBOL(drm_atomic_bridge_chain_check);
 /**
  * drm_bridge_detect - check if anything is attached to the bridge output
  * @bridge: bridge control structure
+ * @connector: connector associated with the bridge
  *
  * If the bridge supports output detection, as reported by the
  * DRM_BRIDGE_OP_DETECT bridge ops flag, call &drm_bridge_funcs.detect for the
-- 
2.43.0
Re: [PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()
Posted by Laurent Pinchart 2 months ago
On Sat, Aug 02, 2025 at 06:13:05PM +0200, Sukrut Heroorkar wrote:
> drm: drm_bridge: fix missing parameter documentation
> 
> The function documentation was missing description for the
> parameter 'connector'.
> 
> Add missing function parameter documentation for drm_bridge_detect()
> to fix kernel-doc warnings.
> 
> Warning: drivers/gpu/drm/drm_bridge.c:1241 function parameter 'connector' not described in 'drm_bridge_detect'
> 

A Fixes: tag would be nice.

> Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
> ---
>  drivers/gpu/drm/drm_bridge.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> index dd45d9b504d8..387a3b6cda54 100644
> --- a/drivers/gpu/drm/drm_bridge.c
> +++ b/drivers/gpu/drm/drm_bridge.c
> @@ -1227,6 +1227,7 @@ EXPORT_SYMBOL(drm_atomic_bridge_chain_check);
>  /**
>   * drm_bridge_detect - check if anything is attached to the bridge output
>   * @bridge: bridge control structure
> + * @connector: connector associated with the bridge

"associated with the bridge" isn't very clear.

>   *
>   * If the bridge supports output detection, as reported by the
>   * DRM_BRIDGE_OP_DETECT bridge ops flag, call &drm_bridge_funcs.detect for the

-- 
Regards,

Laurent Pinchart
Re: [PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()
Posted by sukrut heroorkar 2 months ago
Hi Laurent,

On Sun, Aug 3, 2025 at 6:56 PM Laurent Pinchart
<laurent.pinchart@ideasonboard.com> wrote:
>
> On Sat, Aug 02, 2025 at 06:13:05PM +0200, Sukrut Heroorkar wrote:
> > drm: drm_bridge: fix missing parameter documentation
> >
> > The function documentation was missing description for the
> > parameter 'connector'.
> >
> > Add missing function parameter documentation for drm_bridge_detect()
> > to fix kernel-doc warnings.
> >
> > Warning: drivers/gpu/drm/drm_bridge.c:1241 function parameter 'connector' not described in 'drm_bridge_detect'
> >
>
> A Fixes: tag would be nice.
>
> > Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
> > ---
> >  drivers/gpu/drm/drm_bridge.c | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> > index dd45d9b504d8..387a3b6cda54 100644
> > --- a/drivers/gpu/drm/drm_bridge.c
> > +++ b/drivers/gpu/drm/drm_bridge.c
> > @@ -1227,6 +1227,7 @@ EXPORT_SYMBOL(drm_atomic_bridge_chain_check);
> >  /**
> >   * drm_bridge_detect - check if anything is attached to the bridge output
> >   * @bridge: bridge control structure
> > + * @connector: connector associated with the bridge
>
> "associated with the bridge" isn't very clear.
>
> >   *
> >   * If the bridge supports output detection, as reported by the
> >   * DRM_BRIDGE_OP_DETECT bridge ops flag, call &drm_bridge_funcs.detect for the
>
> --
> Regards,
>
> Laurent Pinchart


Thanks for the review.
I will send a V2 shortly with updated connector description and Fixes
tag, as suggested.
Re: [PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()
Posted by Laurent Pinchart 2 months ago
On Mon, Aug 04, 2025 at 11:24:58PM +0200, sukrut heroorkar wrote:
> On Sun, Aug 3, 2025 at 6:56 PM Laurent Pinchart wrote:
> > On Sat, Aug 02, 2025 at 06:13:05PM +0200, Sukrut Heroorkar wrote:
> > > drm: drm_bridge: fix missing parameter documentation
> > >
> > > The function documentation was missing description for the
> > > parameter 'connector'.
> > >
> > > Add missing function parameter documentation for drm_bridge_detect()
> > > to fix kernel-doc warnings.
> > >
> > > Warning: drivers/gpu/drm/drm_bridge.c:1241 function parameter 'connector' not described in 'drm_bridge_detect'
> > >
> >
> > A Fixes: tag would be nice.
> >
> > > Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
> > > ---
> > >  drivers/gpu/drm/drm_bridge.c | 1 +
> > >  1 file changed, 1 insertion(+)
> > >
> > > diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> > > index dd45d9b504d8..387a3b6cda54 100644
> > > --- a/drivers/gpu/drm/drm_bridge.c
> > > +++ b/drivers/gpu/drm/drm_bridge.c
> > > @@ -1227,6 +1227,7 @@ EXPORT_SYMBOL(drm_atomic_bridge_chain_check);
> > >  /**
> > >   * drm_bridge_detect - check if anything is attached to the bridge output
> > >   * @bridge: bridge control structure
> > > + * @connector: connector associated with the bridge
> >
> > "associated with the bridge" isn't very clear.
> >
> > >   *
> > >   * If the bridge supports output detection, as reported by the
> > >   * DRM_BRIDGE_OP_DETECT bridge ops flag, call &drm_bridge_funcs.detect for the
> 
> Thanks for the review.
> I will send a V2 shortly with updated connector description and Fixes
> tag, as suggested.

It appears that a competing patch got merged in the meantime:
https://lore.kernel.org/r/20250716125602.3166573-1-andyshrk@163.com

It was submitted earlier than yours, and the usual rule in the kernel is
that the first patch wins when there are multiple similar or identical
submissions.

-- 
Regards,

Laurent Pinchart
Re: [PATCH] drm/drm_bridge: Document 'connector' parameter in drm_bridge_detect()
Posted by sukrut heroorkar 2 months ago
On Mon, Aug 4, 2025 at 11:34 PM Laurent Pinchart
<laurent.pinchart@ideasonboard.com> wrote:
>
> On Mon, Aug 04, 2025 at 11:24:58PM +0200, sukrut heroorkar wrote:
> > On Sun, Aug 3, 2025 at 6:56 PM Laurent Pinchart wrote:
> > > On Sat, Aug 02, 2025 at 06:13:05PM +0200, Sukrut Heroorkar wrote:
> > > > drm: drm_bridge: fix missing parameter documentation
> > > >
> > > > The function documentation was missing description for the
> > > > parameter 'connector'.
> > > >
> > > > Add missing function parameter documentation for drm_bridge_detect()
> > > > to fix kernel-doc warnings.
> > > >
> > > > Warning: drivers/gpu/drm/drm_bridge.c:1241 function parameter 'connector' not described in 'drm_bridge_detect'
> > > >
> > >
> > > A Fixes: tag would be nice.
> > >
> > > > Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
> > > > ---
> > > >  drivers/gpu/drm/drm_bridge.c | 1 +
> > > >  1 file changed, 1 insertion(+)
> > > >
> > > > diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> > > > index dd45d9b504d8..387a3b6cda54 100644
> > > > --- a/drivers/gpu/drm/drm_bridge.c
> > > > +++ b/drivers/gpu/drm/drm_bridge.c
> > > > @@ -1227,6 +1227,7 @@ EXPORT_SYMBOL(drm_atomic_bridge_chain_check);
> > > >  /**
> > > >   * drm_bridge_detect - check if anything is attached to the bridge output
> > > >   * @bridge: bridge control structure
> > > > + * @connector: connector associated with the bridge
> > >
> > > "associated with the bridge" isn't very clear.
> > >
> > > >   *
> > > >   * If the bridge supports output detection, as reported by the
> > > >   * DRM_BRIDGE_OP_DETECT bridge ops flag, call &drm_bridge_funcs.detect for the
> >
> > Thanks for the review.
> > I will send a V2 shortly with updated connector description and Fixes
> > tag, as suggested.
>
> It appears that a competing patch got merged in the meantime:
> https://lore.kernel.org/r/20250716125602.3166573-1-andyshrk@163.com
>
> It was submitted earlier than yours, and the usual rule in the kernel is
> that the first patch wins when there are multiple similar or identical
> submissions.
>
> --
> Regards,
>
> Laurent Pinchart

Thanks for the update.

Regards,
Sukrut.