drm/amdgpu: fix two documentation mismatch issues

Submitted by Wang Xiayang on July 19, 2019, 1:19 a.m.

Details

Message ID 20190719011943.10920-1-xywang.sjtu@sjtu.edu.cn
State New
Headers show
Series "drm/amdgpu: fix two documentation mismatch issues" ( rev: 1 ) in AMD X.Org drivers

Not browsing as part of any series.

Commit Message

Wang Xiayang July 19, 2019, 1:19 a.m.
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@sjtu.edu.cn>
---
 drivers/gpu/drm/amd/amdgpu/sdma_v4_0.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Patch hide | download patch | download mbox

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.

Comments

> -----Original Message-----

> From: amd-gfx <amd-gfx-bounces@lists.freedesktop.org> On Behalf Of

> Wang Xiayang

> Sent: Friday, July 19, 2019 9:20 AM

> Cc: Zhou, David(ChunMing) <David1.Zhou@amd.com>; Wang Xiayang

> <xywang.sjtu@sjtu.edu.cn>; trivial@kernel.org; amd-

> gfx@lists.freedesktop.org; Deucher, Alexander

> <Alexander.Deucher@amd.com>; Koenig, Christian

> <Christian.Koenig@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@sjtu.edu.cn>


Reviewed-by: Huang Rui <ray.huang@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@lists.freedesktop.org

> https://lists.freedesktop.org/mailman/listinfo/amd-gfx