[PATCH] drm/amdgpu: fix two documentation mismatch issues

Huang, Ray Ray.Huang at amd.com
Fri Jul 19 07:45:37 UTC 2019


> -----Original Message-----
> From: amd-gfx <amd-gfx-bounces at lists.freedesktop.org> On Behalf Of
> Wang Xiayang
> Sent: Friday, July 19, 2019 9:20 AM
> Cc: Zhou, David(ChunMing) <David1.Zhou at amd.com>; Wang Xiayang
> <xywang.sjtu at sjtu.edu.cn>; trivial at kernel.org; amd-
> gfx at lists.freedesktop.org; Deucher, Alexander
> <Alexander.Deucher at amd.com>; Koenig, Christian
> <Christian.Koenig at amd.com>
> Subject: [PATCH] drm/amdgpu: fix two documentation mismatch issues
> 
> The function name mentioned in the documentational comments
> mismatches the actual one. The mismatch may make trouble for automatic
> documentation generation. One of the erronous name has seen to be
> misused and fixed in commit bc5ab2d29b8a ("drm/amdgpu: fix typo in
> function sdma_v4_0_page_resume").
> 
> There is apparently no functional change in the patch.
> 
> Signed-off-by: Wang Xiayang <xywang.sjtu at sjtu.edu.cn>

Reviewed-by: Huang Rui <ray.huang at amd.com>

> ---
>  drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
> b/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
> index 4428018672d3..3748074220bb 100644
> --- a/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
> +++ b/drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c
> @@ -455,7 +455,7 @@ static uint64_t
> sdma_v4_0_page_ring_get_wptr(struct amdgpu_ring *ring)  }
> 
>  /**
> - * sdma_v4_0_ring_set_wptr - commit the write pointer
> + * sdma_v4_0_page_ring_set_wptr - commit the write pointer
>   *
>   * @ring: amdgpu ring pointer
>   *
> @@ -688,7 +688,7 @@ static void sdma_v4_0_page_stop(struct
> amdgpu_device *adev)  }
> 
>  /**
> - * sdma_v_0_ctx_switch_enable - stop the async dma engines context
> switch
> + * sdma_v4_0_ctx_switch_enable - stop the async dma engines context
> + switch
>   *
>   * @adev: amdgpu_device pointer
>   * @enable: enable/disable the DMA MEs context switch.
> --
> 2.11.0
> 
> _______________________________________________
> amd-gfx mailing list
> amd-gfx at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx


More information about the amd-gfx mailing list