[PATCH] drm/amd/amdgpu: Fix errors in function documentation

[PATCH] drm/amd/amdgpu: Fix errors in function documentation

[Dwaipayan Ray]

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

Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
---
 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(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
index ae9fb2025259..312f24004413 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
@@ -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.
  *
diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
index 16252d48e5a4..7e1a67295106 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
@@ -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.
-- 
2.30.2

Re: [PATCH] drm/amd/amdgpu: Fix errors in function documentation

[Christian König]

Am 09.05.21 um 16:49 schrieb Dwaipayan Ray:
> Fix a couple of syntax errors and removed one excess
> parameter in the function documentations which lead
> to kernel docs build warning.
>
> Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>

Reviewed-by: Christian König <christian.koenig@amd.com>

> ---
>   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(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> index ae9fb2025259..312f24004413 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> @@ -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.
>    *
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> index 16252d48e5a4..7e1a67295106 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> @@ -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.

Re: [PATCH] drm/amd/amdgpu: Fix errors in function documentation

[Alex Deucher]

Applied.  Thanks!

Alex

On Sun, May 9, 2021 at 12:30 PM Christian König
<christian.koenig@amd.com> wrote:
>
> Am 09.05.21 um 16:49 schrieb Dwaipayan Ray:
> > Fix a couple of syntax errors and removed one excess
> > parameter in the function documentations which lead
> > to kernel docs build warning.
> >
> > Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
>
> Reviewed-by: Christian König <christian.koenig@amd.com>
>
> > ---
> >   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(-)
> >
> > diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> > index ae9fb2025259..312f24004413 100644
> > --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> > +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
> > @@ -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.
> >    *
> > diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> > index 16252d48e5a4..7e1a67295106 100644
> > --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> > +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> > @@ -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
> amd-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx