dri-devel.lists.freedesktop.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] drm: Update docs after moving DisplayPort helpers around
@ 2022-01-20 11:36 Thomas Zimmermann
  2022-01-20 11:37 ` Daniel Vetter
  2022-01-21  9:22 ` Jani Nikula
  0 siblings, 2 replies; 3+ messages in thread
From: Thomas Zimmermann @ 2022-01-20 11:36 UTC (permalink / raw)
  To: daniel, airlied, maarten.lankhorst, mripard; +Cc: Thomas Zimmermann, dri-devel

DRM's DisplayPort helpers moved into the subdirectory dp/. Change
the documentation accordingly.

Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
Fixes: adb9d5a2cc77 ("drm/dp: Move DisplayPort helpers into separate helper module")
Reported-by: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Lyude Paul <lyude@redhat.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: dri-devel@lists.freedesktop.org
---
 Documentation/gpu/drm-kms-helpers.rst | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/Documentation/gpu/drm-kms-helpers.rst b/Documentation/gpu/drm-kms-helpers.rst
index 5bb55ec1b9b5..c3ce91eecbc1 100644
--- a/Documentation/gpu/drm-kms-helpers.rst
+++ b/Documentation/gpu/drm-kms-helpers.rst
@@ -232,34 +232,34 @@ HDCP Helper Functions Reference
 Display Port Helper Functions Reference
 =======================================
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
    :doc: dp helpers
 
-.. kernel-doc:: include/drm/drm_dp_helper.h
+.. kernel-doc:: include/drm/dp/drm_dp_helper.h
    :internal:
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
    :export:
 
 Display Port CEC Helper Functions Reference
 ===========================================
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
    :doc: dp cec helpers
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
    :export:
 
 Display Port Dual Mode Adaptor Helper Functions Reference
 =========================================================
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
    :doc: dp dual mode helpers
 
-.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
+.. kernel-doc:: include/drm/dp/drm_dp_dual_mode_helper.h
    :internal:
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
    :export:
 
 Display Port MST Helpers
@@ -268,19 +268,19 @@ Display Port MST Helpers
 Overview
 --------
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
    :doc: dp mst helper
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
    :doc: Branch device and port refcounting
 
 Functions Reference
 -------------------
 
-.. kernel-doc:: include/drm/drm_dp_mst_helper.h
+.. kernel-doc:: include/drm/dp/drm_dp_mst_helper.h
    :internal:
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
    :export:
 
 Topology Lifetime Internals
@@ -289,7 +289,7 @@ Topology Lifetime Internals
 These functions aren't exported to drivers, but are documented here to help make
 the MST topology helpers easier to understand
 
-.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
+.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
    :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
                drm_dp_mst_topology_put_mstb
                drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] drm: Update docs after moving DisplayPort helpers around
  2022-01-20 11:36 [PATCH] drm: Update docs after moving DisplayPort helpers around Thomas Zimmermann
@ 2022-01-20 11:37 ` Daniel Vetter
  2022-01-21  9:22 ` Jani Nikula
  1 sibling, 0 replies; 3+ messages in thread
From: Daniel Vetter @ 2022-01-20 11:37 UTC (permalink / raw)
  To: Thomas Zimmermann; +Cc: airlied, dri-devel

On Thu, Jan 20, 2022 at 12:36 PM Thomas Zimmermann <tzimmermann@suse.de> wrote:
>
> DRM's DisplayPort helpers moved into the subdirectory dp/. Change
> the documentation accordingly.
>
> Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
> Fixes: adb9d5a2cc77 ("drm/dp: Move DisplayPort helpers into separate helper module")
> Reported-by: Jani Nikula <jani.nikula@linux.intel.com>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Lyude Paul <lyude@redhat.com>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: dri-devel@lists.freedesktop.org

Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  Documentation/gpu/drm-kms-helpers.rst | 26 +++++++++++++-------------
>  1 file changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/Documentation/gpu/drm-kms-helpers.rst b/Documentation/gpu/drm-kms-helpers.rst
> index 5bb55ec1b9b5..c3ce91eecbc1 100644
> --- a/Documentation/gpu/drm-kms-helpers.rst
> +++ b/Documentation/gpu/drm-kms-helpers.rst
> @@ -232,34 +232,34 @@ HDCP Helper Functions Reference
>  Display Port Helper Functions Reference
>  =======================================
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
>     :doc: dp helpers
>
> -.. kernel-doc:: include/drm/drm_dp_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_helper.h
>     :internal:
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
>     :export:
>
>  Display Port CEC Helper Functions Reference
>  ===========================================
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
>     :doc: dp cec helpers
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
>     :export:
>
>  Display Port Dual Mode Adaptor Helper Functions Reference
>  =========================================================
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
>     :doc: dp dual mode helpers
>
> -.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_dual_mode_helper.h
>     :internal:
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
>     :export:
>
>  Display Port MST Helpers
> @@ -268,19 +268,19 @@ Display Port MST Helpers
>  Overview
>  --------
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :doc: dp mst helper
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :doc: Branch device and port refcounting
>
>  Functions Reference
>  -------------------
>
> -.. kernel-doc:: include/drm/drm_dp_mst_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_mst_helper.h
>     :internal:
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :export:
>
>  Topology Lifetime Internals
> @@ -289,7 +289,7 @@ Topology Lifetime Internals
>  These functions aren't exported to drivers, but are documented here to help make
>  the MST topology helpers easier to understand
>
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
>                 drm_dp_mst_topology_put_mstb
>                 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port
> --
> 2.34.1
>


-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] drm: Update docs after moving DisplayPort helpers around
  2022-01-20 11:36 [PATCH] drm: Update docs after moving DisplayPort helpers around Thomas Zimmermann
  2022-01-20 11:37 ` Daniel Vetter
@ 2022-01-21  9:22 ` Jani Nikula
  1 sibling, 0 replies; 3+ messages in thread
From: Jani Nikula @ 2022-01-21  9:22 UTC (permalink / raw)
  To: Thomas Zimmermann, daniel, airlied, maarten.lankhorst, mripard
  Cc: Thomas Zimmermann, dri-devel

On Thu, 20 Jan 2022, Thomas Zimmermann <tzimmermann@suse.de> wrote:
> DRM's DisplayPort helpers moved into the subdirectory dp/. Change
> the documentation accordingly.
>
> Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
> Fixes: adb9d5a2cc77 ("drm/dp: Move DisplayPort helpers into separate helper module")
> Reported-by: Jani Nikula <jani.nikula@linux.intel.com>
> Cc: Thomas Zimmermann <tzimmermann@suse.de>
> Cc: Lyude Paul <lyude@redhat.com>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
> Cc: Maxime Ripard <mripard@kernel.org>
> Cc: dri-devel@lists.freedesktop.org

Thanks.

Tested-by: Jani Nikula <jani.nikula@intel.com>

I didn't actually check the generated html, but the errors are gone. ;)

> ---
>  Documentation/gpu/drm-kms-helpers.rst | 26 +++++++++++++-------------
>  1 file changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/Documentation/gpu/drm-kms-helpers.rst b/Documentation/gpu/drm-kms-helpers.rst
> index 5bb55ec1b9b5..c3ce91eecbc1 100644
> --- a/Documentation/gpu/drm-kms-helpers.rst
> +++ b/Documentation/gpu/drm-kms-helpers.rst
> @@ -232,34 +232,34 @@ HDCP Helper Functions Reference
>  Display Port Helper Functions Reference
>  =======================================
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
>     :doc: dp helpers
>  
> -.. kernel-doc:: include/drm/drm_dp_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_helper.h
>     :internal:
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp.c
>     :export:
>  
>  Display Port CEC Helper Functions Reference
>  ===========================================
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
>     :doc: dp cec helpers
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_cec.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_cec.c
>     :export:
>  
>  Display Port Dual Mode Adaptor Helper Functions Reference
>  =========================================================
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
>     :doc: dp dual mode helpers
>  
> -.. kernel-doc:: include/drm/drm_dp_dual_mode_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_dual_mode_helper.h
>     :internal:
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_dual_mode_helper.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_dual_mode_helper.c
>     :export:
>  
>  Display Port MST Helpers
> @@ -268,19 +268,19 @@ Display Port MST Helpers
>  Overview
>  --------
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :doc: dp mst helper
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :doc: Branch device and port refcounting
>  
>  Functions Reference
>  -------------------
>  
> -.. kernel-doc:: include/drm/drm_dp_mst_helper.h
> +.. kernel-doc:: include/drm/dp/drm_dp_mst_helper.h
>     :internal:
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :export:
>  
>  Topology Lifetime Internals
> @@ -289,7 +289,7 @@ Topology Lifetime Internals
>  These functions aren't exported to drivers, but are documented here to help make
>  the MST topology helpers easier to understand
>  
> -.. kernel-doc:: drivers/gpu/drm/drm_dp_mst_topology.c
> +.. kernel-doc:: drivers/gpu/drm/dp/drm_dp_mst_topology.c
>     :functions: drm_dp_mst_topology_try_get_mstb drm_dp_mst_topology_get_mstb
>                 drm_dp_mst_topology_put_mstb
>                 drm_dp_mst_topology_try_get_port drm_dp_mst_topology_get_port

-- 
Jani Nikula, Intel Open Source Graphics Center

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-01-21  9:22 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-20 11:36 [PATCH] drm: Update docs after moving DisplayPort helpers around Thomas Zimmermann
2022-01-20 11:37 ` Daniel Vetter
2022-01-21  9:22 ` Jani Nikula

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).