[11/17] media: qcom: venus: Fix kerneldoc

Message ID 20240126-gix-mtk-warnings-v1-11-eed7865fce18@chromium.org
State New
Headers
Series media: kerneldoc warnings |

Commit Message

Ricardo Ribalda Jan. 26, 2024, 11:16 p.m. UTC
  Remove doc for missing field.

Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
 drivers/media/platform/qcom/venus/core.h | 1 -
 1 file changed, 1 deletion(-)
  

Comments

Randy Dunlap Jan. 27, 2024, 10:13 p.m. UTC | #1
Hi,

On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc for missing field.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  drivers/media/platform/qcom/venus/core.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
> index 4a633261ece4..a39986ce79f1 100644
> --- a/drivers/media/platform/qcom/venus/core.h
> +++ b/drivers/media/platform/qcom/venus/core.h
> @@ -428,7 +428,6 @@ enum venus_inst_modes {
>   * @error:	an error returned during last HFI sync operation
>   * @session_error:	a flag rised by HFI interface in case of session error
>   * @ops:		HFI operations
> - * @priv:	a private for HFI operations callbacks
>   * @session_type:	the type of the session (decoder or encoder)
>   * @hprop:	a union used as a holder by get property
>   * @core_acquired:	the Core has been acquired
> 

I don't understand this one. I do understand the patch above, but the in the struct,
I see:

	unsigned long enc_codecs;
	unsigned long dec_codecs;
	unsigned int max_sessions_supported;
	void *priv;
	const struct hfi_ops *ops;
	struct delayed_work work;

I'm just guessing, but maybe scripts/kernel-doc is confused....
  
Randy Dunlap Jan. 27, 2024, 10:14 p.m. UTC | #2
On 1/27/24 14:13, Randy Dunlap wrote:
> Hi,
> 
> On 1/26/24 15:16, Ricardo Ribalda wrote:
>> Remove doc for missing field.
>>
>> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
>> ---
>>  drivers/media/platform/qcom/venus/core.h | 1 -
>>  1 file changed, 1 deletion(-)
>>
>> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
>> index 4a633261ece4..a39986ce79f1 100644
>> --- a/drivers/media/platform/qcom/venus/core.h
>> +++ b/drivers/media/platform/qcom/venus/core.h
>> @@ -428,7 +428,6 @@ enum venus_inst_modes {
>>   * @error:	an error returned during last HFI sync operation
>>   * @session_error:	a flag rised by HFI interface in case of session error
>>   * @ops:		HFI operations
>> - * @priv:	a private for HFI operations callbacks
>>   * @session_type:	the type of the session (decoder or encoder)
>>   * @hprop:	a union used as a holder by get property
>>   * @core_acquired:	the Core has been acquired
>>
> 
> I don't understand this one. I do understand the patch above, but the in the struct,
> I see:
> 
> 	unsigned long enc_codecs;
> 	unsigned long dec_codecs;
> 	unsigned int max_sessions_supported;
> 	void *priv;
> 	const struct hfi_ops *ops;
> 	struct delayed_work work;
> 
> I'm just guessing, but maybe scripts/kernel-doc is confused....
> 

Nope, I'm confused. The patch is correct.
Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
  

Patch

diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
index 4a633261ece4..a39986ce79f1 100644
--- a/drivers/media/platform/qcom/venus/core.h
+++ b/drivers/media/platform/qcom/venus/core.h
@@ -428,7 +428,6 @@  enum venus_inst_modes {
  * @error:	an error returned during last HFI sync operation
  * @session_error:	a flag rised by HFI interface in case of session error
  * @ops:		HFI operations
- * @priv:	a private for HFI operations callbacks
  * @session_type:	the type of the session (decoder or encoder)
  * @hprop:	a union used as a holder by get property
  * @core_acquired:	the Core has been acquired