[PATCH] drm/bridge: fix kdoc syntax

[PATCH] drm/bridge: fix kdoc syntax

[Luca Ceresoli]

Use the correct kdoc syntax for bullet list.

Fixes kdoc error and warning:

  Documentation/gpu/drm-kms-helpers:197: ./drivers/gpu/drm/drm_bridge.c:1519: ERROR: Unexpected indentation. [docutils]
  Documentation/gpu/drm-kms-helpers:197: ./drivers/gpu/drm/drm_bridge.c:1521: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202512302319.1PGGt3CN-lkp@intel.com/
Fixes: 9da0e06abda8 ("drm/bridge: deprecate of_drm_find_bridge()")
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 drivers/gpu/drm/drm_bridge.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
index 6dcf8f6d3ecf..3b165a0d1e77 100644
--- a/drivers/gpu/drm/drm_bridge.c
+++ b/drivers/gpu/drm/drm_bridge.c
@@ -1518,11 +1518,14 @@ EXPORT_SYMBOL(of_drm_find_and_get_bridge);
  * The bridge returned by this function is not refcounted. This is
  * dangerous because the bridge might be deallocated even before the caller
  * has a chance to use it. To use this function you have to do one of:
+ *
  * - get a reference with drm_bridge_get() as soon as possible to
  *   minimize the race window, and then drm_bridge_put() when no longer
  *   using the pointer
+ *
  * - not call drm_bridge_get() or drm_bridge_put() at all, which used to
  *   be the correct practice before dynamic bridge lifetime was introduced
+ *
  * - again, convert to of_drm_find_and_get_bridge(), which is the only safe
  *   thing to do
  *

---
base-commit: 40630210211a34f0714fe976530ccf1291e5ef78
change-id: 20251231-drm-bridge-alloc-getput-drm_of_find_bridge-kdoc-fix-fb00c84c525a

Best regards,
-- 
Luca Ceresoli <luca.ceresoli@bootlin.com>

Re: [PATCH] drm/bridge: fix kdoc syntax

[Nicolas Frattaroli]

On Wednesday, 31 December 2025 09:22:47 Central European Standard Time Luca Ceresoli wrote:
> Use the correct kdoc syntax for bullet list.
> 
> Fixes kdoc error and warning:
> 
>   Documentation/gpu/drm-kms-helpers:197: ./drivers/gpu/drm/drm_bridge.c:1519: ERROR: Unexpected indentation. [docutils]
>   Documentation/gpu/drm-kms-helpers:197: ./drivers/gpu/drm/drm_bridge.c:1521: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202512302319.1PGGt3CN-lkp@intel.com/
> Fixes: 9da0e06abda8 ("drm/bridge: deprecate of_drm_find_bridge()")
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  drivers/gpu/drm/drm_bridge.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> index 6dcf8f6d3ecf..3b165a0d1e77 100644
> --- a/drivers/gpu/drm/drm_bridge.c
> +++ b/drivers/gpu/drm/drm_bridge.c
> @@ -1518,11 +1518,14 @@ EXPORT_SYMBOL(of_drm_find_and_get_bridge);
>   * The bridge returned by this function is not refcounted. This is
>   * dangerous because the bridge might be deallocated even before the caller
>   * has a chance to use it. To use this function you have to do one of:
> + *
>   * - get a reference with drm_bridge_get() as soon as possible to
>   *   minimize the race window, and then drm_bridge_put() when no longer
>   *   using the pointer
> + *
>   * - not call drm_bridge_get() or drm_bridge_put() at all, which used to
>   *   be the correct practice before dynamic bridge lifetime was introduced
> + *
>   * - again, convert to of_drm_find_and_get_bridge(), which is the only safe
>   *   thing to do
>   *
> 
> ---
> base-commit: 40630210211a34f0714fe976530ccf1291e5ef78
> change-id: 20251231-drm-bridge-alloc-getput-drm_of_find_bridge-kdoc-fix-fb00c84c525a
> 
> Best regards,
> 

Reviewed-by: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>