Skip to contentSkip to conversation

drm/amd/amdgpu: Fix errors in function documentation

PATCH Applied Dwaipayan Ray 3 participants 3 messages May 9, 2021 – May 10, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/amd/amdgpu: Fix errors in function documentation

Fix a couple of syntax errors and removed one excess parameter in the function documentations which lead to kernel docs build warning.

---
 drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c | 3 +++
 drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c  | 1 -
 2 files changed, 3 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c +3 -0
index ae9fb2025259..312f24004413 100644
@@ -320,11 +320,14 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
  * "disable" requires only the block.
  * "enable" requires the block and error type.
  * "inject" requires the block, error type, address, and value.
+ *
  * The block is one of: umc, sdma, gfx, etc.
  *	see ras_block_string[] for details
+ *
  * The error type is one of: ue, ce, where,
  *	ue is multi-uncorrectable
  *	ce is single-correctable
+ *
  * The sub-block is a the sub-block index, pass 0 if there is no sub-block.
  * The address and value are hexadecimal numbers, leading 0x is optional.
  *
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c +0 -1
index 16252d48e5a4..7e1a67295106 100644
@@ -2796,7 +2796,6 @@ long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout)
  *
  * @adev: amdgpu_device pointer
  * @vm: requested vm
- * @vm_context: Indicates if it GFX or Compute context
  * @pasid: Process address space identifier
  *
  * Init @vm fields.
Signature · 1 line
2.30.2
maintainer Reviewed-by on v1 1/1
#1 lore raw

Am 09.05.21 um 16:49 schrieb Dwaipayan Ray:

Quoted 5 lines

Fix a couple of syntax errors and removed one excess parameter in the function documentations which lead to kernel docs build warning.

Quoted 29 lines
---
  drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c | 3 +++
  drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c  | 1 -
  2 files changed, 3 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c +3 -0
index ae9fb2025259..312f24004413 100644
@@ -320,11 +320,14 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
   * "disable" requires only the block.
   * "enable" requires the block and error type.
   * "inject" requires the block, error type, address, and value.
+ *
   * The block is one of: umc, sdma, gfx, etc.
   *	see ras_block_string[] for details
+ *
   * The error type is one of: ue, ce, where,
   *	ue is multi-uncorrectable
   *	ce is single-correctable
+ *
   * The sub-block is a the sub-block index, pass 0 if there is no sub-block.
   * The address and value are hexadecimal numbers, leading 0x is optional.
   *
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c +0 -0
index 16252d48e5a4..7e1a67295106 100644

drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout) · line 2801

Quoted 7 lines
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c +0 -1
@@ -2796,7 +2796,6 @@ long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout)
   *
   * @adev: amdgpu_device pointer
   * @vm: requested vm
- * @vm_context: Indicates if it GFX or Compute context
   * @pasid: Process address space identifier
   *
   * Init @vm fields.

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx

Applied
#2 lore raw

Applied. Thanks!

Alex

Quoted 51 lines · Christian König

Am 09.05.21 um 16:49 schrieb Dwaipayan Ray:

Quoted 5 lines

Fix a couple of syntax errors and removed one excess parameter in the function documentations which lead to kernel docs build warning.

Quoted 29 lines
---
  drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c | 3 +++
  drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c  | 1 -
  2 files changed, 3 insertions(+), 1 deletion(-)
drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c +3 -0
index ae9fb2025259..312f24004413 100644
@@ -320,11 +320,14 @@ static int amdgpu_ras_debugfs_ctrl_parse_data(struct file *f,
   * "disable" requires only the block.
   * "enable" requires the block and error type.
   * "inject" requires the block, error type, address, and value.
+ *
   * The block is one of: umc, sdma, gfx, etc.
   *  see ras_block_string[] for details
+ *
   * The error type is one of: ue, ce, where,
   *  ue is multi-uncorrectable
   *  ce is single-correctable
+ *
   * The sub-block is a the sub-block index, pass 0 if there is no sub-block.
   * The address and value are hexadecimal numbers, leading 0x is optional.
   *
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c +0 -0
index 16252d48e5a4..7e1a67295106 100644

drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout) · line 2801

Quoted 7 lines
drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c +0 -1
@@ -2796,7 +2796,6 @@ long amdgpu_vm_wait_idle(struct amdgpu_vm *vm, long timeout)
   *
   * @adev: amdgpu_device pointer
   * @vm: requested vm
- * @vm_context: Indicates if it GFX or Compute context
   * @pasid: Process address space identifier
   *
   * Init @vm fields.

_______________________________________________
amd-gfx mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/amd-gfx