[PATCH 1/2] drm/panel: Fix kernel-doc typo for `follower_lock`

[PATCH 1/2] drm/panel: Fix kernel-doc typo for `follower_lock`

[Douglas Anderson]

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.
 	 */
-- 
2.41.0.585.gd2178a4bd4-goog

[PATCH 2/2] drm/panel: Fix todo indentation for panel prepared/enabled cleanup

[Douglas Anderson]

In commit d2aacaf07395 ("drm/panel: Check for already prepared/enabled
in drm_panel") the formatting for a code block was not quite
right. This caused an error when building htmldocs:

  Documentation/gpu/todo.rst:469: ERROR: Unexpected indentation.

Fix the error by using the proper syntax for a code block.

Fixes: d2aacaf07395 ("drm/panel: Check for already prepared/enabled in drm_panel")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/r/20230802141724.0edce253@canb.auug.org.au
Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 Documentation/gpu/todo.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
index aa0052f9b93b..139980487ccf 100644
--- a/Documentation/gpu/todo.rst
+++ b/Documentation/gpu/todo.rst
@@ -465,7 +465,8 @@ Clean up checks for already prepared/enabled in panels
 
 In a whole pile of panel drivers, we have code to make the
 prepare/unprepare/enable/disable callbacks behave as no-ops if they've already
-been called. To get some idea of the duplicated code, try:
+been called. To get some idea of the duplicated code, try::
+
   git grep 'if.*>prepared' -- drivers/gpu/drm/panel
   git grep 'if.*>enabled' -- drivers/gpu/drm/panel
 
-- 
2.41.0.585.gd2178a4bd4-goog

Re: [PATCH 2/2] drm/panel: Fix todo indentation for panel prepared/enabled cleanup

[Neil Armstrong]

On 02/08/2023 16:47, Douglas Anderson wrote:
> In commit d2aacaf07395 ("drm/panel: Check for already prepared/enabled
> in drm_panel") the formatting for a code block was not quite
> right. This caused an error when building htmldocs:
> 
>    Documentation/gpu/todo.rst:469: ERROR: Unexpected indentation.
> 
> Fix the error by using the proper syntax for a code block.
> 
> Fixes: d2aacaf07395 ("drm/panel: Check for already prepared/enabled in drm_panel")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/r/20230802141724.0edce253@canb.auug.org.au
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
> 
>   Documentation/gpu/todo.rst | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> index aa0052f9b93b..139980487ccf 100644
> --- a/Documentation/gpu/todo.rst
> +++ b/Documentation/gpu/todo.rst
> @@ -465,7 +465,8 @@ Clean up checks for already prepared/enabled in panels
>   
>   In a whole pile of panel drivers, we have code to make the
>   prepare/unprepare/enable/disable callbacks behave as no-ops if they've already
> -been called. To get some idea of the duplicated code, try:
> +been called. To get some idea of the duplicated code, try::
> +
>     git grep 'if.*>prepared' -- drivers/gpu/drm/panel
>     git grep 'if.*>enabled' -- drivers/gpu/drm/panel
>   

Reviewed-by: Neil Armstrong <neil.armstrong@linaro.org>

Re: [PATCH 1/2] drm/panel: Fix kernel-doc typo for `follower_lock`

[Neil Armstrong]

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>

Re: [PATCH 1/2] drm/panel: Fix kernel-doc typo for `follower_lock`

[Neil Armstrong]

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

-- 
Neil