[3/3] ipa: libipa: v4l2_params: Fix code example in doc
diff mbox series

Message ID 20260505-extensible-stats-v1-3-0b56c7b1bbd6@ideasonboard.com
State New
Headers show
Series
  • ipa: libipa: Add support for V4L2 ISP statistics
Related show

Commit Message

Jacopo Mondi May 5, 2026, 4:11 p.m. UTC
Fix the code example in documentation to actually use the myISPBlocks
type define a few lines above instead of the mis-spelled myISPBlock
type.

Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
---
 src/ipa/libipa/v4l2_params.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart May 5, 2026, 4:43 p.m. UTC | #1
On Tue, May 05, 2026 at 06:11:11PM +0200, Jacopo Mondi wrote:
> Fix the code example in documentation to actually use the myISPBlocks
> type define a few lines above instead of the mis-spelled myISPBlock

The most common form is s/mis-spelled/misspelled/

> type.
> 
> Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/ipa/libipa/v4l2_params.cpp | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/src/ipa/libipa/v4l2_params.cpp b/src/ipa/libipa/v4l2_params.cpp
> index a1eeeb1b0e6a..b756bfee4de2 100644
> --- a/src/ipa/libipa/v4l2_params.cpp
> +++ b/src/ipa/libipa/v4l2_params.cpp
> @@ -146,13 +146,13 @@ namespace ipa {
>   * };
>   *
>   * template<>
> - * struct block_type<myISPBlock::Agc> {
> + * struct block_type<myISPBlocks::Agc> {
>   *	using type = struct my_isp_kernel_config_type_agc;
>   *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AGC;
>   * };
>   *
>   * template<>
> - * struct block_type<myISPBlock::Awb> {
> + * struct block_type<myISPBlocks::Awb> {
>   *	using type = struct my_isp_kernel_config_type_awb;
>   *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AWB;
>   * };
Barnabás Pőcze May 6, 2026, 7:48 a.m. UTC | #2
2026. 05. 05. 18:11 keltezéssel, Jacopo Mondi írta:
> Fix the code example in documentation to actually use the myISPBlocks
> type define a few lines above instead of the mis-spelled myISPBlock
> type.
> 
> Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
> ---

Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>


>   src/ipa/libipa/v4l2_params.cpp | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/src/ipa/libipa/v4l2_params.cpp b/src/ipa/libipa/v4l2_params.cpp
> index a1eeeb1b0e6a..b756bfee4de2 100644
> --- a/src/ipa/libipa/v4l2_params.cpp
> +++ b/src/ipa/libipa/v4l2_params.cpp
> @@ -146,13 +146,13 @@ namespace ipa {
>    * };
>    *
>    * template<>
> - * struct block_type<myISPBlock::Agc> {
> + * struct block_type<myISPBlocks::Agc> {
>    *	using type = struct my_isp_kernel_config_type_agc;
>    *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AGC;
>    * };
>    *
>    * template<>
> - * struct block_type<myISPBlock::Awb> {
> + * struct block_type<myISPBlocks::Awb> {
>    *	using type = struct my_isp_kernel_config_type_awb;
>    *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AWB;
>    * };
>

Patch
diff mbox series

diff --git a/src/ipa/libipa/v4l2_params.cpp b/src/ipa/libipa/v4l2_params.cpp
index a1eeeb1b0e6a..b756bfee4de2 100644
--- a/src/ipa/libipa/v4l2_params.cpp
+++ b/src/ipa/libipa/v4l2_params.cpp
@@ -146,13 +146,13 @@  namespace ipa {
  * };
  *
  * template<>
- * struct block_type<myISPBlock::Agc> {
+ * struct block_type<myISPBlocks::Agc> {
  *	using type = struct my_isp_kernel_config_type_agc;
  *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AGC;
  * };
  *
  * template<>
- * struct block_type<myISPBlock::Awb> {
+ * struct block_type<myISPBlocks::Awb> {
  *	using type = struct my_isp_kernel_config_type_awb;
  *	static constexpr kernel_enum_type blockType = MY_ISP_TYPE_AWB;
  * };