[PATCH] drm/amd/doc: add rough outline of tracepoint documentation

[Tom St Denis]

Fixed with "is".

Thanks.  I'll wait for more feedback before submitting a v2.

Tom

On Thu, May 30, 2019 at 11:45 AM Abramov, Slava <Slava.Abramov at amd.com>
wrote:

> Comments inline (marked with [slava a]).
>
>
> General comment - word capitalisation in the lists is inconsistent
>
>
> ------------------------------
> *From:* amd-gfx <amd-gfx-bounces at lists.freedesktop.org> on behalf of
> StDenis, Tom <Tom.StDenis at amd.com>
> *Sent:* Thursday, May 30, 2019 10:56 AM
> *To:* amd-gfx at lists.freedesktop.org
> *Cc:* StDenis, Tom
> *Subject:* [PATCH] drm/amd/doc: add rough outline of tracepoint
> documentation
>
> Signed-off-by: Tom St Denis <tom.stdenis at amd.com>
> ---
>  Documentation/gpu/amdgpu.rst              |  10 +
>  drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h | 221 ++++++++++++++++++++++
>  2 files changed, 231 insertions(+)
>
> diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
> index 86138798128f..3564765110e5 100644
> --- a/Documentation/gpu/amdgpu.rst
> +++ b/Documentation/gpu/amdgpu.rst
> @@ -89,6 +89,16 @@ AMDGPU RAS debugfs control interface
>  .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
>     :internal:
>
> +AMDGPU Tracing Support
> +======================
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> +   :doc: AMDGPU Tracing Support
> +
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> +   :internal:
> +
>
>  GPU Power/Thermal Controls and Monitoring
>  =========================================
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> b/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> index d3ca2424b5fe..71febb90d3e3 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_trace.h
> @@ -37,6 +37,227 @@
>  #define AMDGPU_JOB_GET_TIMELINE_NAME(job) \
>
> job->base.s_fence->finished.ops->get_timeline_name(&job->base.s_fence->finished)
>
> +/**
> + * DOC: AMDGPU Tracing Support
> + *
> + * The AMDGPU driver provides numerous trace points that can aid
> + * in debugging.  They are globally enabled by the file:
> + *
> + * /sys/kernel/debug/tracing/events/amdgpu/enable
> + *
> + * or individually by the enable files in the sub-directories
> + * of that directory.
> + *
> + * amdgpu_mm_rreg, amdgpu_mm_wreg
> + * ------------------------------
> + *
> + * These trace points track reads and writes to MMIO registers by
> + * the kernel driver (activity inside ring/indirect buffers are not
> + * traced) which can be used to diagnose IP block activity and
> + * responses.
>
> [slava a] Either 'activities are not traced' or 'activity is not traced'
> [slava a] Double usage of word 'activity' sounds weird.
>
> [snap]
> _______________________________________________
> amd-gfx mailing list
> amd-gfx at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/amd-gfx/attachments/20190530/da11a5bc/attachment-0001.html>