[PATCH] drm/dp_mst: Separate @failing_port list in drm_dp_mst_atomic_check_mgr() comment

[PATCH] drm/dp_mst: Separate @failing_port list in drm_dp_mst_atomic_check_mgr() comment

[Bagas Sanjaya]

Stephen Rothwell reported htmldocs warnings when merging drm-intel
tree:

Documentation/gpu/drm-kms-helpers:296: drivers/gpu/drm/display/drm_dp_mst_topology.c:5484: ERROR: Unexpected indentation.
Documentation/gpu/drm-kms-helpers:296: drivers/gpu/drm/display/drm_dp_mst_topology.c:5488: WARNING: Block quote ends without a blank line; unexpected unindent.

Separate @failing_port return value list by surrounding it with a
blank line to fix above warnings.

Fixes: 1cd0a5ea427931 ("drm/dp_mst: Factor out a helper to check the atomic state of a topology manager")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20231114141715.6f435118@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/gpu/drm/display/drm_dp_mst_topology.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/gpu/drm/display/drm_dp_mst_topology.c b/drivers/gpu/drm/display/drm_dp_mst_topology.c
index 0854fe428f173a..b9a98587fbef7f 100644
--- a/drivers/gpu/drm/display/drm_dp_mst_topology.c
+++ b/drivers/gpu/drm/display/drm_dp_mst_topology.c
@@ -5479,6 +5479,7 @@ EXPORT_SYMBOL(drm_dp_mst_atomic_enable_dsc);
  *   - 0 if the new state is valid
  *   - %-ENOSPC, if the new state is invalid, because of BW limitation
  *         @failing_port is set to:
+ *
  *         - The non-root port where a BW limit check failed
  *           with all the ports downstream of @failing_port passing
  *           the BW limit check.
@@ -5487,6 +5488,7 @@ EXPORT_SYMBOL(drm_dp_mst_atomic_enable_dsc);
  *         - %NULL if the BW limit check failed at the root port
  *           with all the ports downstream of the root port passing
  *           the BW limit check.
+ *
  *   - %-EINVAL, if the new state is invalid, because the root port has
  *     too many payloads.
  */

base-commit: 59be90248b422f2924872de0be2867652214096a
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] drm/dp_mst: Separate @failing_port list in drm_dp_mst_atomic_check_mgr() comment

[Jani Nikula]

On Tue, 14 Nov 2023, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> Stephen Rothwell reported htmldocs warnings when merging drm-intel
> tree:
>
> Documentation/gpu/drm-kms-helpers:296: drivers/gpu/drm/display/drm_dp_mst_topology.c:5484: ERROR: Unexpected indentation.
> Documentation/gpu/drm-kms-helpers:296: drivers/gpu/drm/display/drm_dp_mst_topology.c:5488: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Separate @failing_port return value list by surrounding it with a
> blank line to fix above warnings.
>
> Fixes: 1cd0a5ea427931 ("drm/dp_mst: Factor out a helper to check the atomic state of a topology manager")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20231114141715.6f435118@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks, pushed to drm-misc-fixes.

BR,
Jani.

> ---
>  drivers/gpu/drm/display/drm_dp_mst_topology.c | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/drivers/gpu/drm/display/drm_dp_mst_topology.c b/drivers/gpu/drm/display/drm_dp_mst_topology.c
> index 0854fe428f173a..b9a98587fbef7f 100644
> --- a/drivers/gpu/drm/display/drm_dp_mst_topology.c
> +++ b/drivers/gpu/drm/display/drm_dp_mst_topology.c
> @@ -5479,6 +5479,7 @@ EXPORT_SYMBOL(drm_dp_mst_atomic_enable_dsc);
>   *   - 0 if the new state is valid
>   *   - %-ENOSPC, if the new state is invalid, because of BW limitation
>   *         @failing_port is set to:
> + *
>   *         - The non-root port where a BW limit check failed
>   *           with all the ports downstream of @failing_port passing
>   *           the BW limit check.
> @@ -5487,6 +5488,7 @@ EXPORT_SYMBOL(drm_dp_mst_atomic_enable_dsc);
>   *         - %NULL if the BW limit check failed at the root port
>   *           with all the ports downstream of the root port passing
>   *           the BW limit check.
> + *
>   *   - %-EINVAL, if the new state is invalid, because the root port has
>   *     too many payloads.
>   */
>
> base-commit: 59be90248b422f2924872de0be2867652214096a

-- 
Jani Nikula, Intel