Message ID | 20230802074727.1.I4036706ad5e7f45e80d41b777164258e52079cd8@changeid (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | [1/2] drm/panel: Fix kernel-doc typo for `follower_lock` | expand |
On 02/08/2023 16:47, Douglas Anderson wrote: > In the kernel doc for the `follower_lock` member of `struct drm_panel` > there was a typo where it was called `followers_lock`. This resulted > in a warning when making "htmldocs": > > ./include/drm/drm_panel.h:270: warning: > Function parameter or member 'follower_lock' not described in 'drm_panel' > > Fix the typo. > > Fixes: de0874165b83 ("drm/panel: Add a way for other devices to follow panel state") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Closes: https://lore.kernel.org/r/20230802142136.0f67b762@canb.auug.org.au > Signed-off-by: Douglas Anderson <dianders@chromium.org> > --- > > include/drm/drm_panel.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/include/drm/drm_panel.h b/include/drm/drm_panel.h > index d6c73f79c131..10015891b056 100644 > --- a/include/drm/drm_panel.h > +++ b/include/drm/drm_panel.h > @@ -238,7 +238,7 @@ struct drm_panel { > struct list_head followers; > > /** > - * @followers_lock: > + * @follower_lock: > * > * Lock for followers list. > */ Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>
Hi, On Wed, 02 Aug 2023 07:47:27 -0700, Douglas Anderson wrote: > In the kernel doc for the `follower_lock` member of `struct drm_panel` > there was a typo where it was called `followers_lock`. This resulted > in a warning when making "htmldocs": > > ./include/drm/drm_panel.h:270: warning: > Function parameter or member 'follower_lock' not described in 'drm_panel' > > [...] Thanks, Applied to https://anongit.freedesktop.org/git/drm/drm-misc.git (drm-misc-next) [1/2] drm/panel: Fix kernel-doc typo for `follower_lock` https://cgit.freedesktop.org/drm/drm-misc/commit/?id=c0571b20fca4acebd4cb5fcfd07ca4654e9d63dd [2/2] drm/panel: Fix todo indentation for panel prepared/enabled cleanup https://cgit.freedesktop.org/drm/drm-misc/commit/?id=1ab2ddc4afdd84632c24b23dbe67eb4ca423dcc5
diff --git a/include/drm/drm_panel.h b/include/drm/drm_panel.h index d6c73f79c131..10015891b056 100644 --- a/include/drm/drm_panel.h +++ b/include/drm/drm_panel.h @@ -238,7 +238,7 @@ struct drm_panel { struct list_head followers; /** - * @followers_lock: + * @follower_lock: * * Lock for followers list. */
In the kernel doc for the `follower_lock` member of `struct drm_panel` there was a typo where it was called `followers_lock`. This resulted in a warning when making "htmldocs": ./include/drm/drm_panel.h:270: warning: Function parameter or member 'follower_lock' not described in 'drm_panel' Fix the typo. Fixes: de0874165b83 ("drm/panel: Add a way for other devices to follow panel state") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Closes: https://lore.kernel.org/r/20230802142136.0f67b762@canb.auug.org.au Signed-off-by: Douglas Anderson <dianders@chromium.org> --- include/drm/drm_panel.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)