diff mbox series

telemetry: fix docstring of RTE_TEL_INT_VAL

Message ID 20230207084636.1079996-1-rjarry@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series telemetry: fix docstring of RTE_TEL_INT_VAL |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Robin Jarry Feb. 7, 2023, 8:46 a.m. UTC 
  The doc string was left to its previous definition. Make it explicit
that RTE_TEL_INT_VAL is a 64-bit signed integer.

Fixes: 8e639c7c50cc ("telemetry: use 64-bit signed values in API")

Signed-off-by: Robin Jarry <rjarry@redhat.com>
---
 lib/telemetry/rte_telemetry.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Morten Brørup Feb. 7, 2023, 9:51 a.m. UTC | #1 
> From: Robin Jarry [mailto:rjarry@redhat.com]
> Sent: Tuesday, 7 February 2023 09.47
> 
> The doc string was left to its previous definition. Make it explicit
> that RTE_TEL_INT_VAL is a 64-bit signed integer.
> 
> Fixes: 8e639c7c50cc ("telemetry: use 64-bit signed values in API")
> 
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> ---
>  lib/telemetry/rte_telemetry.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/telemetry/rte_telemetry.h
> b/lib/telemetry/rte_telemetry.h
> index ad712732be04..d8ea97f17395 100644
> --- a/lib/telemetry/rte_telemetry.h
> +++ b/lib/telemetry/rte_telemetry.h
> @@ -43,7 +43,7 @@ struct rte_tel_data;
>   */
>  enum rte_tel_value_type {
>  	RTE_TEL_STRING_VAL, /** a string value */
> -	RTE_TEL_INT_VAL,    /** a signed 32-bit int value */
> +	RTE_TEL_INT_VAL,    /** a signed 64-bit int value */
>  	RTE_TEL_UINT_VAL,  /** an unsigned 64-bit int value */
>  	RTE_TEL_CONTAINER, /** a container struct */
>  };
> --
> 2.39.1
> 

Yes, this value type has changed as the comment reflects.

We could consider adding a note that the value does not exceed 32-bit when using API version 23, because the "set" functions in API version 23 only take a 32-bit value parameter. But such a note will be purely informative, and would probably add more confusion than information.

Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
Bruce Richardson Feb. 7, 2023, 10:05 a.m. UTC | #2 
On Tue, Feb 07, 2023 at 09:46:36AM +0100, Robin Jarry wrote:
> The doc string was left to its previous definition. Make it explicit
> that RTE_TEL_INT_VAL is a 64-bit signed integer.
> 
> Fixes: 8e639c7c50cc ("telemetry: use 64-bit signed values in API")
> 
> Signed-off-by: Robin Jarry <rjarry@redhat.com>
> ---
>  lib/telemetry/rte_telemetry.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h
> index ad712732be04..d8ea97f17395 100644
> --- a/lib/telemetry/rte_telemetry.h
> +++ b/lib/telemetry/rte_telemetry.h
> @@ -43,7 +43,7 @@ struct rte_tel_data;
>   */
>  enum rte_tel_value_type {
>  	RTE_TEL_STRING_VAL, /** a string value */
> -	RTE_TEL_INT_VAL,    /** a signed 32-bit int value */
> +	RTE_TEL_INT_VAL,    /** a signed 64-bit int value */
>  	RTE_TEL_UINT_VAL,  /** an unsigned 64-bit int value */
>  	RTE_TEL_CONTAINER, /** a container struct */
>  };
Thanks for catching this.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
David Marchand Feb. 9, 2023, 9:18 a.m. UTC | #3 
On Tue, Feb 7, 2023 at 9:46 AM Robin Jarry <rjarry@redhat.com> wrote:
>
> The doc string was left to its previous definition. Make it explicit
> that RTE_TEL_INT_VAL is a 64-bit signed integer.
>
> Fixes: 8e639c7c50cc ("telemetry: use 64-bit signed values in API")
>
> Signed-off-by: Robin Jarry <rjarry@redhat.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/lib/telemetry/rte_telemetry.h b/lib/telemetry/rte_telemetry.h
index ad712732be04..d8ea97f17395 100644
--- a/lib/telemetry/rte_telemetry.h
+++ b/lib/telemetry/rte_telemetry.h
@@ -43,7 +43,7 @@  struct rte_tel_data;
  */
 enum rte_tel_value_type {
 	RTE_TEL_STRING_VAL, /** a string value */
-	RTE_TEL_INT_VAL,    /** a signed 32-bit int value */
+	RTE_TEL_INT_VAL,    /** a signed 64-bit int value */
 	RTE_TEL_UINT_VAL,  /** an unsigned 64-bit int value */
 	RTE_TEL_CONTAINER, /** a container struct */
 };