dri-devel.lists.freedesktop.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] drm/ttm: update kernel-doc line comments
@ 2020-09-18  9:52 Tian Tao
  2020-09-18 10:44 ` Huang Rui
  0 siblings, 1 reply; 4+ messages in thread
From: Tian Tao @ 2020-09-18  9:52 UTC (permalink / raw)
  To: christian.koenig, ray.huang, airlied, daniel, dri-devel; +Cc: linuxarm

Update kernel-doc line comments to fix warnings reported by make W=1.

drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
member 'glob' not described in 'ttm_shrink'
drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
member 'from_wq' not described in 'ttm_shrink'
drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
member 'extra' not described in 'ttm_shrink'
drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
member 'ctx' not described in 'ttm_shrink'

Signed-off-by: Tian Tao <tiantao6@hisilicon.com>
---
 drivers/gpu/drm/ttm/ttm_memory.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/ttm/ttm_memory.c b/drivers/gpu/drm/ttm/ttm_memory.c
index acd63b7..0b51773 100644
--- a/drivers/gpu/drm/ttm/ttm_memory.c
+++ b/drivers/gpu/drm/ttm/ttm_memory.c
@@ -259,7 +259,7 @@ static bool ttm_zones_above_swap_target(struct ttm_mem_global *glob,
 	return false;
 }
 
-/**
+/*
  * At this point we only support a single shrink callback.
  * Extend this if needed, perhaps using a linked list of callbacks.
  * Note that this function is reentrant:
-- 
2.7.4

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] drm/ttm: update kernel-doc line comments
  2020-09-18  9:52 [PATCH] drm/ttm: update kernel-doc line comments Tian Tao
@ 2020-09-18 10:44 ` Huang Rui
  2020-09-18 12:46   ` Daniel Vetter
  0 siblings, 1 reply; 4+ messages in thread
From: Huang Rui @ 2020-09-18 10:44 UTC (permalink / raw)
  To: Tian Tao; +Cc: airlied, dri-devel, Koenig, Christian, linuxarm

On Fri, Sep 18, 2020 at 05:52:58PM +0800, Tian Tao wrote:
> Update kernel-doc line comments to fix warnings reported by make W=1.
> 
> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> member 'glob' not described in 'ttm_shrink'
> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> member 'from_wq' not described in 'ttm_shrink'
> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> member 'extra' not described in 'ttm_shrink'
> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> member 'ctx' not described in 'ttm_shrink'
> 
> Signed-off-by: Tian Tao <tiantao6@hisilicon.com>

Acked-by: Huang Rui <ray.huang@amd.com>

> ---
>  drivers/gpu/drm/ttm/ttm_memory.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/ttm/ttm_memory.c b/drivers/gpu/drm/ttm/ttm_memory.c
> index acd63b7..0b51773 100644
> --- a/drivers/gpu/drm/ttm/ttm_memory.c
> +++ b/drivers/gpu/drm/ttm/ttm_memory.c
> @@ -259,7 +259,7 @@ static bool ttm_zones_above_swap_target(struct ttm_mem_global *glob,
>  	return false;
>  }
>  
> -/**
> +/*
>   * At this point we only support a single shrink callback.
>   * Extend this if needed, perhaps using a linked list of callbacks.
>   * Note that this function is reentrant:
> -- 
> 2.7.4
> 
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] drm/ttm: update kernel-doc line comments
  2020-09-18 10:44 ` Huang Rui
@ 2020-09-18 12:46   ` Daniel Vetter
  2020-09-18 12:53     ` Christian König
  0 siblings, 1 reply; 4+ messages in thread
From: Daniel Vetter @ 2020-09-18 12:46 UTC (permalink / raw)
  To: Huang Rui; +Cc: airlied, linuxarm, dri-devel, Tian Tao, Koenig, Christian

On Fri, Sep 18, 2020 at 06:44:25PM +0800, Huang Rui wrote:
> On Fri, Sep 18, 2020 at 05:52:58PM +0800, Tian Tao wrote:
> > Update kernel-doc line comments to fix warnings reported by make W=1.
> > 
> > drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> > member 'glob' not described in 'ttm_shrink'
> > drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> > member 'from_wq' not described in 'ttm_shrink'
> > drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> > member 'extra' not described in 'ttm_shrink'
> > drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
> > member 'ctx' not described in 'ttm_shrink'
> > 
> > Signed-off-by: Tian Tao <tiantao6@hisilicon.com>
> 
> Acked-by: Huang Rui <ray.huang@amd.com>

It would be nice to go through ttm docs and polish them so their proper.
This patch here just shuts up the warning without fixing any of the
documentation issues. Fixing the docs would be much better.
-Daniel

> 
> > ---
> >  drivers/gpu/drm/ttm/ttm_memory.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/gpu/drm/ttm/ttm_memory.c b/drivers/gpu/drm/ttm/ttm_memory.c
> > index acd63b7..0b51773 100644
> > --- a/drivers/gpu/drm/ttm/ttm_memory.c
> > +++ b/drivers/gpu/drm/ttm/ttm_memory.c
> > @@ -259,7 +259,7 @@ static bool ttm_zones_above_swap_target(struct ttm_mem_global *glob,
> >  	return false;
> >  }
> >  
> > -/**
> > +/*
> >   * At this point we only support a single shrink callback.
> >   * Extend this if needed, perhaps using a linked list of callbacks.
> >   * Note that this function is reentrant:
> > -- 
> > 2.7.4
> > 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] drm/ttm: update kernel-doc line comments
  2020-09-18 12:46   ` Daniel Vetter
@ 2020-09-18 12:53     ` Christian König
  0 siblings, 0 replies; 4+ messages in thread
From: Christian König @ 2020-09-18 12:53 UTC (permalink / raw)
  To: Daniel Vetter, Huang Rui; +Cc: airlied, Tian Tao, linuxarm, dri-devel

Am 18.09.20 um 14:46 schrieb Daniel Vetter:
> On Fri, Sep 18, 2020 at 06:44:25PM +0800, Huang Rui wrote:
>> On Fri, Sep 18, 2020 at 05:52:58PM +0800, Tian Tao wrote:
>>> Update kernel-doc line comments to fix warnings reported by make W=1.
>>>
>>> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
>>> member 'glob' not described in 'ttm_shrink'
>>> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
>>> member 'from_wq' not described in 'ttm_shrink'
>>> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
>>> member 'extra' not described in 'ttm_shrink'
>>> drivers/gpu/drm/ttm/ttm_memory.c:271: warning: Function parameter or
>>> member 'ctx' not described in 'ttm_shrink'
>>>
>>> Signed-off-by: Tian Tao <tiantao6@hisilicon.com>
>> Acked-by: Huang Rui <ray.huang@amd.com>
> It would be nice to go through ttm docs and polish them so their proper.
> This patch here just shuts up the warning without fixing any of the
> documentation issues. Fixing the docs would be much better.

Yeah, but I would do this only after Dave and I are done with re-writing 
this :)

Otherwise it is just a waste of time.

Christian.

> -Daniel
>
>>> ---
>>>   drivers/gpu/drm/ttm/ttm_memory.c | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/gpu/drm/ttm/ttm_memory.c b/drivers/gpu/drm/ttm/ttm_memory.c
>>> index acd63b7..0b51773 100644
>>> --- a/drivers/gpu/drm/ttm/ttm_memory.c
>>> +++ b/drivers/gpu/drm/ttm/ttm_memory.c
>>> @@ -259,7 +259,7 @@ static bool ttm_zones_above_swap_target(struct ttm_mem_global *glob,
>>>   	return false;
>>>   }
>>>   
>>> -/**
>>> +/*
>>>    * At this point we only support a single shrink callback.
>>>    * Extend this if needed, perhaps using a linked list of callbacks.
>>>    * Note that this function is reentrant:
>>> -- 
>>> 2.7.4
>>>

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-09-19  8:46 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-18  9:52 [PATCH] drm/ttm: update kernel-doc line comments Tian Tao
2020-09-18 10:44 ` Huang Rui
2020-09-18 12:46   ` Daniel Vetter
2020-09-18 12:53     ` Christian König

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).