diff mbox series

drm: amdgpu: fix kernel-doc struct warning

Message ID 20200420015015.27991-2-rdunlap@infradead.org (mailing list archive)
State New, archived
Headers show
Series drm: amdgpu: fix kernel-doc struct warning | expand

Commit Message

Randy Dunlap April 20, 2020, 1:50 a.m. UTC
Fix a kernel-doc warning of missing struct field desription:

../drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:92: warning: Function parameter or member 'vm' not described in 'amdgpu_vm_eviction_lock'

Fixes: a269e44989f3 ("drm/amdgpu: Avoid reclaim fs while eviction lock")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Signed-off-by: Alex Sierra <alex.sierra@amd.com>
Cc: Felix Kuehling <Felix.Kuehling@amd.com>
Cc: Christian König <christian.koenig@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: David (ChunMing) Zhou <David1.Zhou@amd.com>
Cc: amd-gfx@lists.freedesktop.org
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Harry Wentland April 21, 2020, 2:13 p.m. UTC | #1
On 2020-04-19 9:50 p.m., Randy Dunlap wrote:
> Fix a kernel-doc warning of missing struct field desription:
> 
> ../drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:92: warning: Function parameter or member 'vm' not described in 'amdgpu_vm_eviction_lock'
> 
> Fixes: a269e44989f3 ("drm/amdgpu: Avoid reclaim fs while eviction lock")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Signed-off-by: Alex Sierra <alex.sierra@amd.com>
> Cc: Felix Kuehling <Felix.Kuehling@amd.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: David (ChunMing) Zhou <David1.Zhou@amd.com>
> Cc: amd-gfx@lists.freedesktop.org


Reviewed-by: Harry Wentland <harry.wentland@amd.com>

Harry

> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-57-rc2.orig/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> +++ lnx-57-rc2/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> @@ -82,7 +82,7 @@ struct amdgpu_prt_cb {
>  	struct dma_fence_cb cb;
>  };
>  
> -/**
> +/*
>   * vm eviction_lock can be taken in MMU notifiers. Make sure no reclaim-FS
>   * happens while holding this lock anywhere to prevent deadlocks when
>   * an MMU notifier runs in reclaim-FS context.
>
Christian König April 21, 2020, 2:33 p.m. UTC | #2
Am 20.04.20 um 03:50 schrieb Randy Dunlap:
> Fix a kernel-doc warning of missing struct field desription:
>
> ../drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:92: warning: Function parameter or member 'vm' not described in 'amdgpu_vm_eviction_lock'

Can't we just document the function parameter instead? Should only be 
one IIRC.

Thanks,
Christian.

>
> Fixes: a269e44989f3 ("drm/amdgpu: Avoid reclaim fs while eviction lock")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Signed-off-by: Alex Sierra <alex.sierra@amd.com>
> Cc: Felix Kuehling <Felix.Kuehling@amd.com>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: David (ChunMing) Zhou <David1.Zhou@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> ---
>   drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c |    2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- lnx-57-rc2.orig/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> +++ lnx-57-rc2/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> @@ -82,7 +82,7 @@ struct amdgpu_prt_cb {
>   	struct dma_fence_cb cb;
>   };
>   
> -/**
> +/*
>    * vm eviction_lock can be taken in MMU notifiers. Make sure no reclaim-FS
>    * happens while holding this lock anywhere to prevent deadlocks when
>    * an MMU notifier runs in reclaim-FS context.
Christian König April 21, 2020, 2:34 p.m. UTC | #3
Am 21.04.20 um 16:33 schrieb Christian König:
> Am 20.04.20 um 03:50 schrieb Randy Dunlap:
>> Fix a kernel-doc warning of missing struct field desription:
>>
>> ../drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:92: warning: Function 
>> parameter or member 'vm' not described in 'amdgpu_vm_eviction_lock'
>
> Can't we just document the function parameter instead? Should only be 
> one IIRC.

On the other hand forget that, the format doesn't match a proper 
kernel-doc for a function anyway.

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

>
> Thanks,
> Christian.
>
>>
>> Fixes: a269e44989f3 ("drm/amdgpu: Avoid reclaim fs while eviction lock")
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Signed-off-by: Alex Sierra <alex.sierra@amd.com>
>> Cc: Felix Kuehling <Felix.Kuehling@amd.com>
>> Cc: Christian König <christian.koenig@amd.com>
>> Cc: Alex Deucher <alexander.deucher@amd.com>
>> Cc: David (ChunMing) Zhou <David1.Zhou@amd.com>
>> Cc: amd-gfx@lists.freedesktop.org
>> ---
>>   drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c |    2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> --- lnx-57-rc2.orig/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
>> +++ lnx-57-rc2/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
>> @@ -82,7 +82,7 @@ struct amdgpu_prt_cb {
>>       struct dma_fence_cb cb;
>>   };
>>   -/**
>> +/*
>>    * vm eviction_lock can be taken in MMU notifiers. Make sure no 
>> reclaim-FS
>>    * happens while holding this lock anywhere to prevent deadlocks when
>>    * an MMU notifier runs in reclaim-FS context.
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
Alex Deucher April 22, 2020, 8:04 p.m. UTC | #4
On Tue, Apr 21, 2020 at 10:34 AM Christian König
<ckoenig.leichtzumerken@gmail.com> wrote:
>
> Am 21.04.20 um 16:33 schrieb Christian König:
> > Am 20.04.20 um 03:50 schrieb Randy Dunlap:
> >> Fix a kernel-doc warning of missing struct field desription:
> >>
> >> ../drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c:92: warning: Function
> >> parameter or member 'vm' not described in 'amdgpu_vm_eviction_lock'
> >
> > Can't we just document the function parameter instead? Should only be
> > one IIRC.
>
> On the other hand forget that, the format doesn't match a proper
> kernel-doc for a function anyway.
>
> Reviewed-by: Christian König <christian.koenig@amd.com>
>

Applied.  Thanks!

Alex

> >
> > Thanks,
> > Christian.
> >
> >>
> >> Fixes: a269e44989f3 ("drm/amdgpu: Avoid reclaim fs while eviction lock")
> >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> >> Cc: Signed-off-by: Alex Sierra <alex.sierra@amd.com>
> >> Cc: Felix Kuehling <Felix.Kuehling@amd.com>
> >> Cc: Christian König <christian.koenig@amd.com>
> >> Cc: Alex Deucher <alexander.deucher@amd.com>
> >> Cc: David (ChunMing) Zhou <David1.Zhou@amd.com>
> >> Cc: amd-gfx@lists.freedesktop.org
> >> ---
> >>   drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c |    2 +-
> >>   1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> --- lnx-57-rc2.orig/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> >> +++ lnx-57-rc2/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
> >> @@ -82,7 +82,7 @@ struct amdgpu_prt_cb {
> >>       struct dma_fence_cb cb;
> >>   };
> >>   -/**
> >> +/*
> >>    * vm eviction_lock can be taken in MMU notifiers. Make sure no
> >> reclaim-FS
> >>    * happens while holding this lock anywhere to prevent deadlocks when
> >>    * an MMU notifier runs in reclaim-FS context.
> >
> > _______________________________________________
> > amd-gfx mailing list
> > amd-gfx@lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/amd-gfx
>
> _______________________________________________
> amd-gfx mailing list
> amd-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx
diff mbox series

Patch

--- lnx-57-rc2.orig/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
+++ lnx-57-rc2/drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
@@ -82,7 +82,7 @@  struct amdgpu_prt_cb {
 	struct dma_fence_cb cb;
 };
 
-/**
+/*
  * vm eviction_lock can be taken in MMU notifiers. Make sure no reclaim-FS
  * happens while holding this lock anywhere to prevent deadlocks when
  * an MMU notifier runs in reclaim-FS context.