[02/15] libipa: awb: Capitalize AWB
diff mbox series

Message ID 20250223230403.1226-3-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libipa: awb: Drive-by fixes
Related show

Commit Message

Laurent Pinchart Feb. 23, 2025, 11:03 p.m. UTC
AWB is an abbreviation, capitalize it in comments and log messages for
consistency.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/ipa/libipa/awb.cpp      | 14 +++++++-------
 src/ipa/libipa/awb_grey.cpp |  4 ++--
 2 files changed, 9 insertions(+), 9 deletions(-)

Comments

Stefan Klug Feb. 24, 2025, 8:59 a.m. UTC | #1
Hi Laurent,

Thank you for the patch. 

On Mon, Feb 24, 2025 at 01:03:50AM +0200, Laurent Pinchart wrote:
> AWB is an abbreviation, capitalize it in comments and log messages for
> consistency.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> 

> ---
>  src/ipa/libipa/awb.cpp      | 14 +++++++-------
>  src/ipa/libipa/awb_grey.cpp |  4 ++--
>  2 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
> index 2e78a4665509..dc672f129c4a 100644
> --- a/src/ipa/libipa/awb.cpp
> +++ b/src/ipa/libipa/awb.cpp
> @@ -24,7 +24,7 @@ namespace ipa {
>  
>  /**
>   * \class AwbResult
> - * \brief The result of an awb calculation
> + * \brief The result of an AWB calculation
>   *
>   * This class holds the result of an auto white balance calculation.
>   */
> @@ -57,7 +57,7 @@ namespace ipa {
>   * applied. To keep the actual implementations computationally inexpensive,
>   * the squared colour error shall be returned.
>   *
> - * If the awb statistics provide multiple zones, the average of the individual
> + * If the AWB statistics provide multiple zones, the average of the individual
>   * squared errors shall be returned. Averaging/normalizing is necessary so that
>   * the numeric dimensions are the same on all hardware platforms.
>   *
> @@ -94,7 +94,7 @@ namespace ipa {
>  
>  /**
>   * \fn AwbAlgorithm::calculateAwb
> - * \brief Calculate awb data from the given statistics
> + * \brief Calculate AWB data from the given statistics
>   * \param[in] stats The statistics to use for the calculation
>   * \param[in] lux The lux value of the scene
>   *
> @@ -102,7 +102,7 @@ namespace ipa {
>   * lux value of 0 means it is unknown or invalid and the algorithm shall ignore
>   * it.
>   *
> - * \return The awb result
> + * \return The AWB result
>   */
>  
>  /**
> @@ -178,14 +178,14 @@ int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
>  		if (controls::AwbModeNameValueMap.find(modeName) ==
>  		    controls::AwbModeNameValueMap.end()) {
>  			LOG(Awb, Warning)
> -				<< "Skipping unknown awb mode '"
> +				<< "Skipping unknown AWB mode '"
>  				<< modeName << "'";
>  			continue;
>  		}
>  
>  		if (!modeDict.isDictionary()) {
>  			LOG(Awb, Error)
> -				<< "Invalid awb mode '" << modeName << "'";
> +				<< "Invalid AWB mode '" << modeName << "'";
>  			return -EINVAL;
>  		}
>  
> @@ -235,7 +235,7 @@ int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
>   * \class AwbAlgorithm::ModeConfig
>   * \brief Holds the configuration of a single AWB mode
>   *
> - * Awb modes limit the regulation of the AWB algorithm to a specific range of
> + * AWB modes limit the regulation of the AWB algorithm to a specific range of
>   * colour temperatures.
>   */
>  
> diff --git a/src/ipa/libipa/awb_grey.cpp b/src/ipa/libipa/awb_grey.cpp
> index 49448976ed26..06ffd45618d8 100644
> --- a/src/ipa/libipa/awb_grey.cpp
> +++ b/src/ipa/libipa/awb_grey.cpp
> @@ -57,7 +57,7 @@ int AwbGrey::init(const YamlObject &tuningData)
>  }
>  
>  /**
> - * \brief Calculate awb data from the given statistics
> + * \brief Calculate AWB data from the given statistics
>   * \param[in] stats The statistics to use for the calculation
>   * \param[in] lux The lux value of the scene
>   *
> @@ -68,7 +68,7 @@ int AwbGrey::init(const YamlObject &tuningData)
>   *
>   * The \a lux parameter is not used in this algorithm.
>   *
> - * \return The awb result
> + * \return The AWB result
>   */
>  AwbResult AwbGrey::calculateAwb(const AwbStats &stats, [[maybe_unused]] int lux)
>  {
> -- 
> Regards,
> 
> Laurent Pinchart
>

Patch
diff mbox series

diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
index 2e78a4665509..dc672f129c4a 100644
--- a/src/ipa/libipa/awb.cpp
+++ b/src/ipa/libipa/awb.cpp
@@ -24,7 +24,7 @@  namespace ipa {
 
 /**
  * \class AwbResult
- * \brief The result of an awb calculation
+ * \brief The result of an AWB calculation
  *
  * This class holds the result of an auto white balance calculation.
  */
@@ -57,7 +57,7 @@  namespace ipa {
  * applied. To keep the actual implementations computationally inexpensive,
  * the squared colour error shall be returned.
  *
- * If the awb statistics provide multiple zones, the average of the individual
+ * If the AWB statistics provide multiple zones, the average of the individual
  * squared errors shall be returned. Averaging/normalizing is necessary so that
  * the numeric dimensions are the same on all hardware platforms.
  *
@@ -94,7 +94,7 @@  namespace ipa {
 
 /**
  * \fn AwbAlgorithm::calculateAwb
- * \brief Calculate awb data from the given statistics
+ * \brief Calculate AWB data from the given statistics
  * \param[in] stats The statistics to use for the calculation
  * \param[in] lux The lux value of the scene
  *
@@ -102,7 +102,7 @@  namespace ipa {
  * lux value of 0 means it is unknown or invalid and the algorithm shall ignore
  * it.
  *
- * \return The awb result
+ * \return The AWB result
  */
 
 /**
@@ -178,14 +178,14 @@  int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
 		if (controls::AwbModeNameValueMap.find(modeName) ==
 		    controls::AwbModeNameValueMap.end()) {
 			LOG(Awb, Warning)
-				<< "Skipping unknown awb mode '"
+				<< "Skipping unknown AWB mode '"
 				<< modeName << "'";
 			continue;
 		}
 
 		if (!modeDict.isDictionary()) {
 			LOG(Awb, Error)
-				<< "Invalid awb mode '" << modeName << "'";
+				<< "Invalid AWB mode '" << modeName << "'";
 			return -EINVAL;
 		}
 
@@ -235,7 +235,7 @@  int AwbAlgorithm::parseModeConfigs(const YamlObject &tuningData,
  * \class AwbAlgorithm::ModeConfig
  * \brief Holds the configuration of a single AWB mode
  *
- * Awb modes limit the regulation of the AWB algorithm to a specific range of
+ * AWB modes limit the regulation of the AWB algorithm to a specific range of
  * colour temperatures.
  */
 
diff --git a/src/ipa/libipa/awb_grey.cpp b/src/ipa/libipa/awb_grey.cpp
index 49448976ed26..06ffd45618d8 100644
--- a/src/ipa/libipa/awb_grey.cpp
+++ b/src/ipa/libipa/awb_grey.cpp
@@ -57,7 +57,7 @@  int AwbGrey::init(const YamlObject &tuningData)
 }
 
 /**
- * \brief Calculate awb data from the given statistics
+ * \brief Calculate AWB data from the given statistics
  * \param[in] stats The statistics to use for the calculation
  * \param[in] lux The lux value of the scene
  *
@@ -68,7 +68,7 @@  int AwbGrey::init(const YamlObject &tuningData)
  *
  * The \a lux parameter is not used in this algorithm.
  *
- * \return The awb result
+ * \return The AWB result
  */
 AwbResult AwbGrey::calculateAwb(const AwbStats &stats, [[maybe_unused]] int lux)
 {