[PATCH 2/2] Documentation: Fix bug in example code snippet

Patrick Little posted 2 patches 1 week, 3 days ago
[PATCH 2/2] Documentation: Fix bug in example code snippet
Posted by Patrick Little 1 week, 3 days ago
A semicolon was mistakenly placed at the end of 'if' statements.
If example is copied as-is, it would lead to the subsequent return
being executed unconditionally, which is incorrect, and the rest of the
function would never be reached.

Signed-off-by: Patrick Little <plittle@gmail.com>
---
 Documentation/power/energy-model.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/power/energy-model.rst b/Documentation/power/energy-model.rst
index 65133187f2ad..0d4644d72767 100644
--- a/Documentation/power/energy-model.rst
+++ b/Documentation/power/energy-model.rst
@@ -308,12 +308,12 @@ EM framework::
   05
   06		/* Use the 'foo' protocol to ceil the frequency */
   07		freq = foo_get_freq_ceil(dev, *KHz);
-  08		if (freq < 0);
+  08		if (freq < 0)
   09			return freq;
   10
   11		/* Estimate the power cost for the dev at the relevant freq. */
   12		power = foo_estimate_power(dev, freq);
-  13		if (power < 0);
+  13		if (power < 0)
   14			return power;
   15
   16		/* Return the values to the EM framework */

-- 
2.51.0
Re: [PATCH 2/2] Documentation: Fix bug in example code snippet
Posted by Randy Dunlap 1 week, 3 days ago

On 1/28/26 2:33 PM, Patrick Little wrote:
> A semicolon was mistakenly placed at the end of 'if' statements.
> If example is copied as-is, it would lead to the subsequent return
> being executed unconditionally, which is incorrect, and the rest of the
> function would never be reached.
> 
> Signed-off-by: Patrick Little <plittle@gmail.com>

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

Thanks.

> ---
>  Documentation/power/energy-model.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/power/energy-model.rst b/Documentation/power/energy-model.rst
> index 65133187f2ad..0d4644d72767 100644
> --- a/Documentation/power/energy-model.rst
> +++ b/Documentation/power/energy-model.rst
> @@ -308,12 +308,12 @@ EM framework::
>    05
>    06		/* Use the 'foo' protocol to ceil the frequency */
>    07		freq = foo_get_freq_ceil(dev, *KHz);
> -  08		if (freq < 0);
> +  08		if (freq < 0)
>    09			return freq;
>    10
>    11		/* Estimate the power cost for the dev at the relevant freq. */
>    12		power = foo_estimate_power(dev, freq);
> -  13		if (power < 0);
> +  13		if (power < 0)
>    14			return power;
>    15
>    16		/* Return the values to the EM framework */
> 

-- 
~Randy