| Message ID | 20240228164636.1540903-1-imre.deak@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/dp: Fix documentation of DP tunnel functions | expand |
On Wed, Feb 28, 2024 at 06:46:36PM +0200, Imre Deak wrote: > Fix the documentation issues below, also reported by 'make htmldocs': > > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tunnel' not described in 'drm_dp_tunnel_put' > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tracker' not described in 'drm_dp_tunnel_put' > drivers/gpu/drm/display/drm_dp_tunnel.c:1185: warning: expecting prototype for drm_dp_tunnel_atomic_get_allocated_bw(). Prototype was for drm_dp_tunnel_get_allocated_bw() instead > drivers/gpu/drm/display/drm_dp_tunnel.c:1903: warning: Function parameter or struct member 'max_group_count' not described in 'drm_dp_tunnel_mgr_create' > > Fixes: 295654f7e554 ("drm/dp: Add support for DP tunneling") > Reported-by: kernel test robot <lkp@intel.com> > Signed-off-by: Imre Deak <imre.deak@intel.com> Reviewed-by: Ville Syrjälä <ville.syrjala@linux.intel.com> > --- > drivers/gpu/drm/display/drm_dp_tunnel.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/drivers/gpu/drm/display/drm_dp_tunnel.c b/drivers/gpu/drm/display/drm_dp_tunnel.c > index 120e0de674c19..017f1d4c63415 100644 > --- a/drivers/gpu/drm/display/drm_dp_tunnel.c > +++ b/drivers/gpu/drm/display/drm_dp_tunnel.c > @@ -436,8 +436,8 @@ EXPORT_SYMBOL(drm_dp_tunnel_get); > > /** > * drm_dp_tunnel_put - Put a reference for a DP tunnel > - * @tunnel - Tunnel object > - * @tracker - Debug tracker for the reference > + * @tunnel: Tunnel object > + * @tracker: Debug tracker for the reference > * > * Put a reference for @tunnel along with its debug *@tracker, which > * was obtained with drm_dp_tunnel_get(). > @@ -1170,7 +1170,7 @@ int drm_dp_tunnel_alloc_bw(struct drm_dp_tunnel *tunnel, int bw) > EXPORT_SYMBOL(drm_dp_tunnel_alloc_bw); > > /** > - * drm_dp_tunnel_atomic_get_allocated_bw - Get the BW allocated for a DP tunnel > + * drm_dp_tunnel_get_allocated_bw - Get the BW allocated for a DP tunnel > * @tunnel: Tunnel object > * > * Get the current BW allocated for @tunnel. After the tunnel is created / > @@ -1892,6 +1892,7 @@ static void destroy_mgr(struct drm_dp_tunnel_mgr *mgr) > /** > * drm_dp_tunnel_mgr_create - Create a DP tunnel manager > * @dev: DRM device object > + * @max_group_count: Maximum number of tunnel groups > * > * Creates a DP tunnel manager for @dev. > * > -- > 2.43.3
On Wed, 28 Feb 2024, Imre Deak <imre.deak@intel.com> wrote: > Fix the documentation issues below, also reported by 'make htmldocs': > > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tunnel' not described in 'drm_dp_tunnel_put' > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tracker' not described in 'drm_dp_tunnel_put' > drivers/gpu/drm/display/drm_dp_tunnel.c:1185: warning: expecting prototype for drm_dp_tunnel_atomic_get_allocated_bw(). Prototype was for drm_dp_tunnel_get_allocated_bw() instead > drivers/gpu/drm/display/drm_dp_tunnel.c:1903: warning: Function parameter or struct member 'max_group_count' not described in 'drm_dp_tunnel_mgr_create' > > Fixes: 295654f7e554 ("drm/dp: Add support for DP tunneling") > Reported-by: kernel test robot <lkp@intel.com> > Signed-off-by: Imre Deak <imre.deak@intel.com> This came up today [1]. Even if the regressing commit was merged via drm-intel, you still need the acks for queueing non-i915 changes via drm-intel, and the acks absolutely must be recorded in the commit messages when pushing the patches. dim should complain about applying non-i915 patches without acks. BR, Jani. [1] https://lore.kernel.org/r/Zh_Q72gYKMMbge9A@intel.com > --- > drivers/gpu/drm/display/drm_dp_tunnel.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/drivers/gpu/drm/display/drm_dp_tunnel.c b/drivers/gpu/drm/display/drm_dp_tunnel.c > index 120e0de674c19..017f1d4c63415 100644 > --- a/drivers/gpu/drm/display/drm_dp_tunnel.c > +++ b/drivers/gpu/drm/display/drm_dp_tunnel.c > @@ -436,8 +436,8 @@ EXPORT_SYMBOL(drm_dp_tunnel_get); > > /** > * drm_dp_tunnel_put - Put a reference for a DP tunnel > - * @tunnel - Tunnel object > - * @tracker - Debug tracker for the reference > + * @tunnel: Tunnel object > + * @tracker: Debug tracker for the reference > * > * Put a reference for @tunnel along with its debug *@tracker, which > * was obtained with drm_dp_tunnel_get(). > @@ -1170,7 +1170,7 @@ int drm_dp_tunnel_alloc_bw(struct drm_dp_tunnel *tunnel, int bw) > EXPORT_SYMBOL(drm_dp_tunnel_alloc_bw); > > /** > - * drm_dp_tunnel_atomic_get_allocated_bw - Get the BW allocated for a DP tunnel > + * drm_dp_tunnel_get_allocated_bw - Get the BW allocated for a DP tunnel > * @tunnel: Tunnel object > * > * Get the current BW allocated for @tunnel. After the tunnel is created / > @@ -1892,6 +1892,7 @@ static void destroy_mgr(struct drm_dp_tunnel_mgr *mgr) > /** > * drm_dp_tunnel_mgr_create - Create a DP tunnel manager > * @dev: DRM device object > + * @max_group_count: Maximum number of tunnel groups > * > * Creates a DP tunnel manager for @dev. > *
On Fri, Apr 19, 2024 at 03:40:39PM +0300, Jani Nikula wrote: > On Wed, 28 Feb 2024, Imre Deak <imre.deak@intel.com> wrote: > > Fix the documentation issues below, also reported by 'make htmldocs': > > > > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tunnel' not described in 'drm_dp_tunnel_put' > > drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tracker' not described in 'drm_dp_tunnel_put' > > drivers/gpu/drm/display/drm_dp_tunnel.c:1185: warning: expecting prototype for drm_dp_tunnel_atomic_get_allocated_bw(). Prototype was for drm_dp_tunnel_get_allocated_bw() instead > > drivers/gpu/drm/display/drm_dp_tunnel.c:1903: warning: Function parameter or struct member 'max_group_count' not described in 'drm_dp_tunnel_mgr_create' > > > > Fixes: 295654f7e554 ("drm/dp: Add support for DP tunneling") > > Reported-by: kernel test robot <lkp@intel.com> > > Signed-off-by: Imre Deak <imre.deak@intel.com> > > This came up today [1]. Even if the regressing commit was merged via > drm-intel, you still need the acks for queueing non-i915 changes via > drm-intel, and the acks absolutely must be recorded in the commit > messages when pushing the patches. There wasn't a reason to merge this via drm-intel instead of drm-misc-next, not sure why I did that; otherwise I always ask and record the acks. > dim should complain about applying non-i915 patches without acks. I don't remember seeing it this time, but yes it should complain and require an override; maybe I managed to overlook somehow that as well. > BR, > Jani. > > > [1] https://lore.kernel.org/r/Zh_Q72gYKMMbge9A@intel.com > > > > > --- > > drivers/gpu/drm/display/drm_dp_tunnel.c | 7 ++++--- > > 1 file changed, 4 insertions(+), 3 deletions(-) > > > > diff --git a/drivers/gpu/drm/display/drm_dp_tunnel.c b/drivers/gpu/drm/display/drm_dp_tunnel.c > > index 120e0de674c19..017f1d4c63415 100644 > > --- a/drivers/gpu/drm/display/drm_dp_tunnel.c > > +++ b/drivers/gpu/drm/display/drm_dp_tunnel.c > > @@ -436,8 +436,8 @@ EXPORT_SYMBOL(drm_dp_tunnel_get); > > > > /** > > * drm_dp_tunnel_put - Put a reference for a DP tunnel > > - * @tunnel - Tunnel object > > - * @tracker - Debug tracker for the reference > > + * @tunnel: Tunnel object > > + * @tracker: Debug tracker for the reference > > * > > * Put a reference for @tunnel along with its debug *@tracker, which > > * was obtained with drm_dp_tunnel_get(). > > @@ -1170,7 +1170,7 @@ int drm_dp_tunnel_alloc_bw(struct drm_dp_tunnel *tunnel, int bw) > > EXPORT_SYMBOL(drm_dp_tunnel_alloc_bw); > > > > /** > > - * drm_dp_tunnel_atomic_get_allocated_bw - Get the BW allocated for a DP tunnel > > + * drm_dp_tunnel_get_allocated_bw - Get the BW allocated for a DP tunnel > > * @tunnel: Tunnel object > > * > > * Get the current BW allocated for @tunnel. After the tunnel is created / > > @@ -1892,6 +1892,7 @@ static void destroy_mgr(struct drm_dp_tunnel_mgr *mgr) > > /** > > * drm_dp_tunnel_mgr_create - Create a DP tunnel manager > > * @dev: DRM device object > > + * @max_group_count: Maximum number of tunnel groups > > * > > * Creates a DP tunnel manager for @dev. > > * > > -- > Jani Nikula, Intel
diff --git a/drivers/gpu/drm/display/drm_dp_tunnel.c b/drivers/gpu/drm/display/drm_dp_tunnel.c index 120e0de674c19..017f1d4c63415 100644 --- a/drivers/gpu/drm/display/drm_dp_tunnel.c +++ b/drivers/gpu/drm/display/drm_dp_tunnel.c @@ -436,8 +436,8 @@ EXPORT_SYMBOL(drm_dp_tunnel_get); /** * drm_dp_tunnel_put - Put a reference for a DP tunnel - * @tunnel - Tunnel object - * @tracker - Debug tracker for the reference + * @tunnel: Tunnel object + * @tracker: Debug tracker for the reference * * Put a reference for @tunnel along with its debug *@tracker, which * was obtained with drm_dp_tunnel_get(). @@ -1170,7 +1170,7 @@ int drm_dp_tunnel_alloc_bw(struct drm_dp_tunnel *tunnel, int bw) EXPORT_SYMBOL(drm_dp_tunnel_alloc_bw); /** - * drm_dp_tunnel_atomic_get_allocated_bw - Get the BW allocated for a DP tunnel + * drm_dp_tunnel_get_allocated_bw - Get the BW allocated for a DP tunnel * @tunnel: Tunnel object * * Get the current BW allocated for @tunnel. After the tunnel is created / @@ -1892,6 +1892,7 @@ static void destroy_mgr(struct drm_dp_tunnel_mgr *mgr) /** * drm_dp_tunnel_mgr_create - Create a DP tunnel manager * @dev: DRM device object + * @max_group_count: Maximum number of tunnel groups * * Creates a DP tunnel manager for @dev. *
Fix the documentation issues below, also reported by 'make htmldocs': drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tunnel' not described in 'drm_dp_tunnel_put' drivers/gpu/drm/display/drm_dp_tunnel.c:447: warning: Function parameter or struct member 'tracker' not described in 'drm_dp_tunnel_put' drivers/gpu/drm/display/drm_dp_tunnel.c:1185: warning: expecting prototype for drm_dp_tunnel_atomic_get_allocated_bw(). Prototype was for drm_dp_tunnel_get_allocated_bw() instead drivers/gpu/drm/display/drm_dp_tunnel.c:1903: warning: Function parameter or struct member 'max_group_count' not described in 'drm_dp_tunnel_mgr_create' Fixes: 295654f7e554 ("drm/dp: Add support for DP tunneling") Reported-by: kernel test robot <lkp@intel.com> Signed-off-by: Imre Deak <imre.deak@intel.com> --- drivers/gpu/drm/display/drm_dp_tunnel.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)