[PATCH 2/2] drm/amdgpu: fix documentation of amdgpu_mn.c

[Michel Dänzer]

On 2018-06-05 11:48 AM, Christian König wrote:
> And wire it up as well.
> 
> Signed-off-by: Christian König <christian.koenig at amd.com>

Did you run

 make htmldocs

or another documentation target, check that it doesn't print any
warnings about amdgpu_mn.c, and look at the generated documentation?


> diff --git a/Documentation/gpu/amdgpu.rst b/Documentation/gpu/amdgpu.rst
> index 1fbf3876a3d8..420271081c31 100644
> --- a/Documentation/gpu/amdgpu.rst
> +++ b/Documentation/gpu/amdgpu.rst
> @@ -35,3 +35,12 @@ PRIME Buffer Sharing
>  
>  .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_prime.c
>     :internal:
> +
> +MMU Notifier
> +--------------------

The underline length doesn't match the headline length.


> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
> +   :doc: MMU Notifier
> +
> +.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
> +   :internal:
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
> index 36ed7b1b6cf0..9e44b6e21e67 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
> @@ -28,6 +28,21 @@
>   *    Christian König <christian.koenig at amd.com>
>   */
>  
> +/**
> + * DOC: amdgpu MMU notifier

The identifier after DOC: here and after :doc: in amdgpu.rst must match,
otherwise you should get a warning like

./drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c:1: warning: no structured
comments found

and the DOC comment body is missing from the generated documentation.


> + * For coherent userptr handling registers an MMU notifier to inform the driver
> + * about updates on a page tables of a process.

Something like "updates to page tables" instead of "updates on a page
tables"?


With the above fixed,

Reviewed-by: Michel Dänzer <michel.daenzer at amd.com>


-- 
Earthling Michel Dänzer               |               http://www.amd.com
Libre software enthusiast             |             Mesa and X developer