diff mbox series

accel: Link to compute accelerator subsystem intro

Message ID 20230307043525.25660-1-bagasdotme@gmail.com
State New
Headers
Series accel: Link to compute accelerator subsystem intro |

Commit Message

Bagas Sanjaya March 7, 2023, 4:35 a.m. UTC 
  Commit 2c204f3d53218d ("accel: add dedicated minor for accelerator
devices") adds link to accelerator nodes section of DRM internals doc
(Documentation/gpu/drm-internals.rst), but the target doesn't exist.
Instead, there is only an introduction doc for computer accelerator
subsytem.

Link to that doc until there is documentation of accelerator internals.

Fixes: 2c204f3d53218d ("accel: add dedicated minor for accelerator devices")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---

 This comes from discussion on Dylan Le's attempted fix, where Jeffrey
 Hugo suspected that the proper target should be accelerator subsystem
 doc [2].

 [1]: https://lore.kernel.org/linux-doc/7799513f0fb5aee27b64752c037980471be669c5.1677120686.git.self@dylanle.dev/
 [2]: https://lore.kernel.org/linux-doc/CAOCk7NrAKZ2G-VbQW3MJUZmkKkO1Ccrs2wo12kg6QHysH-d=Yg@mail.gmail.com/

 include/drm/drm_file.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)


base-commit: 5c8cf1664f288098a971a1d1e65716a2b6a279e1

Comments

Jeffrey Hugo March 7, 2023, 4:03 p.m. UTC | #1 
On 3/6/2023 9:35 PM, Bagas Sanjaya wrote:
> Commit 2c204f3d53218d ("accel: add dedicated minor for accelerator
> devices") adds link to accelerator nodes section of DRM internals doc
> (Documentation/gpu/drm-internals.rst), but the target doesn't exist.
> Instead, there is only an introduction doc for computer accelerator
> subsytem.
> 
> Link to that doc until there is documentation of accelerator internals.
> 
> Fixes: 2c204f3d53218d ("accel: add dedicated minor for accelerator devices")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
Oded Gabbay March 19, 2023, 8:27 a.m. UTC | #2 
On Tue, Mar 7, 2023 at 6:04 PM Jeffrey Hugo <quic_jhugo@quicinc.com> wrote:
>
> On 3/6/2023 9:35 PM, Bagas Sanjaya wrote:
> > Commit 2c204f3d53218d ("accel: add dedicated minor for accelerator
> > devices") adds link to accelerator nodes section of DRM internals doc
> > (Documentation/gpu/drm-internals.rst), but the target doesn't exist.
> > Instead, there is only an introduction doc for computer accelerator
> > subsytem.
> >
> > Link to that doc until there is documentation of accelerator internals.
> >
> > Fixes: 2c204f3d53218d ("accel: add dedicated minor for accelerator devices")
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
> Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
Thanks.
Will upstream through my tree (habanalabs-next)
Oded
diff mbox series

Patch

diff --git a/include/drm/drm_file.h b/include/drm/drm_file.h
index 0d1f853092ab8a..ecffe24e2b1b0a 100644
--- a/include/drm/drm_file.h
+++ b/include/drm/drm_file.h
@@ -408,7 +408,8 @@  static inline bool drm_is_render_client(const struct drm_file *file_priv)
  * Returns true if this is an open file of the compute acceleration node, i.e.
  * &drm_file.minor of @file_priv is a accel minor.
  *
- * See also the :ref:`section on accel nodes <drm_accel_node>`.
+ * See also :doc:`Introduction to compute accelerators subsystem
+ * </accel/introduction>`.
  */
 static inline bool drm_is_accel_client(const struct drm_file *file_priv)
 {