diff mbox series

drm/i915/gt: Update engine_init_common documentation

Message ID 20230309165852.1251-1-nirmoy.das@intel.com (mailing list archive)
State New, archived
Headers show
Series drm/i915/gt: Update engine_init_common documentation | expand

Commit Message

Nirmoy Das March 9, 2023, 4:58 p.m. UTC
Change the function doc to reflect updated name.

Cc: Andi Shyti <andi.shyti@linux.intel.com>
Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
---
 drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Matt Roper March 9, 2023, 5:33 p.m. UTC | #1
On Thu, Mar 09, 2023 at 05:58:52PM +0100, Nirmoy Das wrote:
> Change the function doc to reflect updated name.
> 
> Cc: Andi Shyti <andi.shyti@linux.intel.com>
> Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
> ---
>  drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> index ad3413242100..83532630b639 100644
> --- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> +++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> @@ -1429,7 +1429,7 @@ create_kernel_context(struct intel_engine_cs *engine)
>  }
>  
>  /**

Should we also un-kerneldoc this comment?  Generally we don't use
kerneldoc comments for static functions.


Matt

> - * intel_engines_init_common - initialize cengine state which might require hw access
> + * engines_init_common - initialize engine state which might require hw access
>   * @engine: Engine to initialize.
>   *
>   * Initializes @engine@ structure members shared between legacy and execlists
> -- 
> 2.39.0
>
Nirmoy Das March 9, 2023, 6:39 p.m. UTC | #2
On 3/9/2023 6:33 PM, Matt Roper wrote:
> On Thu, Mar 09, 2023 at 05:58:52PM +0100, Nirmoy Das wrote:
>> Change the function doc to reflect updated name.
>>
>> Cc: Andi Shyti <andi.shyti@linux.intel.com>
>> Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
>> ---
>>   drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> index ad3413242100..83532630b639 100644
>> --- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> +++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> @@ -1429,7 +1429,7 @@ create_kernel_context(struct intel_engine_cs *engine)
>>   }
>>   
>>   /**
> Should we also un-kerneldoc this comment?  Generally we don't use
> kerneldoc comments for static functions.

Yes. I will resend replacing "/**" with "/*" .


Nirmoy

>
>
> Matt
>
>> - * intel_engines_init_common - initialize cengine state which might require hw access
>> + * engines_init_common - initialize engine state which might require hw access
>>    * @engine: Engine to initialize.
>>    *
>>    * Initializes @engine@ structure members shared between legacy and execlists
>> -- 
>> 2.39.0
>>
Andi Shyti March 9, 2023, 10:25 p.m. UTC | #3
Hi Nirmoy,

On Thu, Mar 09, 2023 at 05:58:52PM +0100, Nirmoy Das wrote:
> Change the function doc to reflect updated name.
> 
> Cc: Andi Shyti <andi.shyti@linux.intel.com>
> Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
> ---
>  drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> index ad3413242100..83532630b639 100644
> --- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> +++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> @@ -1429,7 +1429,7 @@ create_kernel_context(struct intel_engine_cs *engine)
>  }
>  
>  /**
> - * intel_engines_init_common - initialize cengine state which might require hw access
> + * engines_init_common - initialize engine state which might require hw access

You had one change to make and you missed it :-D

/engines_init_common/engine_init_common/

Andi

>   * @engine: Engine to initialize.
>   *
>   * Initializes @engine@ structure members shared between legacy and execlists
> -- 
> 2.39.0
Nirmoy Das March 10, 2023, 8:37 a.m. UTC | #4
On 3/9/2023 11:25 PM, Andi Shyti wrote:
> Hi Nirmoy,
>
> On Thu, Mar 09, 2023 at 05:58:52PM +0100, Nirmoy Das wrote:
>> Change the function doc to reflect updated name.
>>
>> Cc: Andi Shyti <andi.shyti@linux.intel.com>
>> Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
>> ---
>>   drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> index ad3413242100..83532630b639 100644
>> --- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> +++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
>> @@ -1429,7 +1429,7 @@ create_kernel_context(struct intel_engine_cs *engine)
>>   }
>>   
>>   /**
>> - * intel_engines_init_common - initialize cengine state which might require hw access
>> + * engines_init_common - initialize engine state which might require hw access
> You had one change to make and you missed it :-D

*facepalm*


>
> /engines_init_common/engine_init_common/
>
> Andi
>
>>    * @engine: Engine to initialize.
>>    *
>>    * Initializes @engine@ structure members shared between legacy and execlists
>> -- 
>> 2.39.0
Andi Shyti March 10, 2023, 9:36 a.m. UTC | #5
> > On Thu, Mar 09, 2023 at 05:58:52PM +0100, Nirmoy Das wrote:
> > > Change the function doc to reflect updated name.
> > > 
> > > Cc: Andi Shyti <andi.shyti@linux.intel.com>
> > > Signed-off-by: Nirmoy Das <nirmoy.das@intel.com>
> > > ---
> > >   drivers/gpu/drm/i915/gt/intel_engine_cs.c | 2 +-
> > >   1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> > > index ad3413242100..83532630b639 100644
> > > --- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> > > +++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
> > > @@ -1429,7 +1429,7 @@ create_kernel_context(struct intel_engine_cs *engine)
> > >   }
> > >   /**
> > > - * intel_engines_init_common - initialize cengine state which might require hw access
> > > + * engines_init_common - initialize engine state which might require hw access
> > You had one change to make and you missed it :-D
> 
> *facepalm*

btw, with that change,

Reviewed-by: Andi Shyti <andi.shyti@linux.intel.com>

Andi

> > /engines_init_common/engine_init_common/
> > 
> > Andi
> > 
> > >    * @engine: Engine to initialize.
> > >    *
> > >    * Initializes @engine@ structure members shared between legacy and execlists
> > > -- 
> > > 2.39.0
diff mbox series

Patch

diff --git a/drivers/gpu/drm/i915/gt/intel_engine_cs.c b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
index ad3413242100..83532630b639 100644
--- a/drivers/gpu/drm/i915/gt/intel_engine_cs.c
+++ b/drivers/gpu/drm/i915/gt/intel_engine_cs.c
@@ -1429,7 +1429,7 @@  create_kernel_context(struct intel_engine_cs *engine)
 }
 
 /**
- * intel_engines_init_common - initialize cengine state which might require hw access
+ * engines_init_common - initialize engine state which might require hw access
  * @engine: Engine to initialize.
  *
  * Initializes @engine@ structure members shared between legacy and execlists