Re: [PATCH 03/10] drm/bridge: Add documentation sections

[Sam Ravnborg <sam@ravnborg.org>]

On Tue, Jul 20, 2021 at 03:45:18PM +0200, Maxime Ripard wrote:
> The bridge documentation overview is quite packed already, and we'll add
> some more documentation that isn't part of an overview at all.
> 
> Let's add some sections to the documentation to separare each bits.
s/separare/separate/
> 
> Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>
> ---
>  Documentation/gpu/drm-kms-helpers.rst |  6 ++++++
>  drivers/gpu/drm/drm_bridge.c          | 14 +++++++++-----
>  2 files changed, 15 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/gpu/drm-kms-helpers.rst b/Documentation/gpu/drm-kms-helpers.rst
> index 389892f36185..10f8df7aecc0 100644
> --- a/Documentation/gpu/drm-kms-helpers.rst
> +++ b/Documentation/gpu/drm-kms-helpers.rst
> @@ -151,6 +151,12 @@ Overview
>  .. kernel-doc:: drivers/gpu/drm/drm_bridge.c
>     :doc: overview
>  
> +Display Driver Integration
> +--------------------------
> +
> +.. kernel-doc:: drivers/gpu/drm/drm_bridge.c
> +   :doc: display driver integration
> +
>  Bridge Operations
>  -----------------
>  
> diff --git a/drivers/gpu/drm/drm_bridge.c b/drivers/gpu/drm/drm_bridge.c
> index aef8c9f4fb9f..c9a950bfdfe5 100644
> --- a/drivers/gpu/drm/drm_bridge.c
> +++ b/drivers/gpu/drm/drm_bridge.c
> @@ -50,6 +50,15 @@
>   * Chaining multiple bridges to the output of a bridge, or the same bridge to
>   * the output of different bridges, is not supported.
>   *
> + * &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes,
> + * CRTCs, encoders or connectors and hence are not visible to userspace. They
> + * just provide additional hooks to get the desired output at the end of the
> + * encoder chain.
> + */
> +
> +/**
> + * DOC:	display driver integration
> + *
>   * Display drivers are responsible for linking encoders with the first bridge
>   * in the chains. This is done by acquiring the appropriate bridge with
>   * drm_of_get_next(). Once acquired, the bridge shall be attached to the
> @@ -84,11 +93,6 @@
>   * helper to create the &drm_connector, or implement it manually on top of the
>   * connector-related operations exposed by the bridge (see the overview
>   * documentation of bridge operations for more details).
> - *
> - * &drm_bridge, like &drm_panel, aren't &drm_mode_object entities like planes,
> - * CRTCs, encoders or connectors and hence are not visible to userspace. They
> - * just provide additional hooks to get the desired output at the end of the
> - * encoder chain.
>   */
>  
>  static DEFINE_MUTEX(bridge_lock);
> -- 
> 2.31.1