Re: [PATCH 2/2] drm/xe: Wire up devcoredump in documentation

[Matthew Brost <matthew.brost@intel.com>]

On Thu, Oct 31, 2024 at 11:29:16AM -0700, Lucas De Marchi wrote:
> Add a documentation page to detail the device coredump as implemented by
> xe - it was documented in the source code, but not visible in the
> rendered (html) documentation.
> 
> Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>

Reviewed-by: Matthew Brost <matthew.brost@intel.com>

> ---
>  Documentation/gpu/xe/index.rst          |  1 +
>  Documentation/gpu/xe/xe_devcoredump.rst | 14 ++++++++++++++
>  2 files changed, 15 insertions(+)
>  create mode 100644 Documentation/gpu/xe/xe_devcoredump.rst
> 
> diff --git a/Documentation/gpu/xe/index.rst b/Documentation/gpu/xe/index.rst
> index 3f07aa3b54325..92cfb25e64d32 100644
> --- a/Documentation/gpu/xe/index.rst
> +++ b/Documentation/gpu/xe/index.rst
> @@ -23,4 +23,5 @@ DG2, etc is provided to prototype the driver.
>     xe_firmware
>     xe_tile
>     xe_debugging
> +   xe_devcoredump
>     xe-drm-usage-stats.rst
> diff --git a/Documentation/gpu/xe/xe_devcoredump.rst b/Documentation/gpu/xe/xe_devcoredump.rst
> new file mode 100644
> index 0000000000000..ae4ec0e34dc01
> --- /dev/null
> +++ b/Documentation/gpu/xe/xe_devcoredump.rst
> @@ -0,0 +1,14 @@
> +.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
> +
> +==================
> +Xe Device Coredump
> +==================
> +
> +.. kernel-doc:: drivers/gpu/drm/xe/xe_devcoredump.c
> +   :doc: Xe device coredump
> +
> +Internal API
> +============
> +
> +.. kernel-doc:: drivers/gpu/drm/xe/xe_devcoredump.c
> +   :internal:
> -- 
> 2.47.0
>