[PATCH] drm/ttm: update kernel-doc line comments

[PATCH] drm/ttm: update kernel-doc line comments

[Tian Tao]

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

Re: [PATCH] drm/ttm: update kernel-doc line comments

[Huang Rui]

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

Re: [PATCH] drm/ttm: update kernel-doc line comments

[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.
-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

Re: [PATCH] drm/ttm: update kernel-doc line comments

[Christian König]

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