[PATCH] drm/amd: Remove errors from sphinx documentation

Michel Dänzer michel at daenzer.net
Mon Jul 2 07:41:01 UTC 2018


Hi Darren,


thanks for working on this.


On 2018-06-30 12:10 AM, Powell, Darren wrote:
> 
> Subject: [PATCH 1/2] drm/amd: Remove errors from sphinx documentation
> 
> Eliminating the warnings produced by sphinx when processing the sphinx comments in
>  amdgpu_device.c

The commit log should mention that the patch modifies amdgpu_mn.c as
well. With that fixed,

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


> Subject: [PATCH 2/2] drm/amd: Add sphinx documentation for amd_ip_funcs
> 
> [...]
> 
> +	/**
> +	 * @name: Name of IP block
> +	 */
>  	char *name;

FWIW, single-line member descriptions can be single-line comments:

	/** @name: Name of IP block */
 	char *name;

Either way though,

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


More information about the amd-gfx mailing list