Documentation: power: Fix typo in suspend and interrupts doc

[PATCH] Documentation: power: Fix typo in suspend and interrupts doc

Posted by Saravana Kannan 1 year, 11 months ago

Typos are bad. Fix them.

Signed-off-by: Saravana Kannan <saravanak@google.com>
---
 Documentation/power/suspend-and-interrupts.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/power/suspend-and-interrupts.rst b/Documentation/power/suspend-and-interrupts.rst
index dfbace2f4600..f588feeecad0 100644
--- a/Documentation/power/suspend-and-interrupts.rst
+++ b/Documentation/power/suspend-and-interrupts.rst
@@ -78,7 +78,7 @@ handling the given IRQ as a system wakeup interrupt line and disable_irq_wake()
 turns that logic off.
 
 Calling enable_irq_wake() causes suspend_device_irqs() to treat the given IRQ
-in a special way.  Namely, the IRQ remains enabled, by on the first interrupt
+in a special way.  Namely, the IRQ remains enabled, but on the first interrupt
 it will be disabled, marked as pending and "suspended" so that it will be
 re-enabled by resume_device_irqs() during the subsequent system resume.  Also
 the PM core is notified about the event which causes the system suspend in
-- 
2.44.0.278.ge034bb2e1d-goog

Re: [PATCH] Documentation: power: Fix typo in suspend and interrupts doc

Posted by Rafael J. Wysocki 1 year, 11 months ago

On Fri, Mar 8, 2024 at 11:45 PM Saravana Kannan <saravanak@google.com> wrote:
>
> Typos are bad. Fix them.
>
> Signed-off-by: Saravana Kannan <saravanak@google.com>
> ---
>  Documentation/power/suspend-and-interrupts.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/power/suspend-and-interrupts.rst b/Documentation/power/suspend-and-interrupts.rst
> index dfbace2f4600..f588feeecad0 100644
> --- a/Documentation/power/suspend-and-interrupts.rst
> +++ b/Documentation/power/suspend-and-interrupts.rst
> @@ -78,7 +78,7 @@ handling the given IRQ as a system wakeup interrupt line and disable_irq_wake()
>  turns that logic off.
>
>  Calling enable_irq_wake() causes suspend_device_irqs() to treat the given IRQ
> -in a special way.  Namely, the IRQ remains enabled, by on the first interrupt
> +in a special way.  Namely, the IRQ remains enabled, but on the first interrupt
>  it will be disabled, marked as pending and "suspended" so that it will be
>  re-enabled by resume_device_irqs() during the subsequent system resume.  Also
>  the PM core is notified about the event which causes the system suspend in
> --

Applied as 6.9-rc material, thanks!

Re: [PATCH] Documentation: power: Fix typo in suspend and interrupts doc

Posted by Dhruva Gole 1 year, 11 months ago

On Mar 08, 2024 at 14:44:50 -0800, Saravana Kannan wrote:
> Typos are bad. Fix them.

Maybe a little more description that you s/by/but would've also made
things more clear?

> 
> Signed-off-by: Saravana Kannan <saravanak@google.com>
> ---
>  Documentation/power/suspend-and-interrupts.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/power/suspend-and-interrupts.rst b/Documentation/power/suspend-and-interrupts.rst
> index dfbace2f4600..f588feeecad0 100644
> --- a/Documentation/power/suspend-and-interrupts.rst
> +++ b/Documentation/power/suspend-and-interrupts.rst
> @@ -78,7 +78,7 @@ handling the given IRQ as a system wakeup interrupt line and disable_irq_wake()
>  turns that logic off.
>  
>  Calling enable_irq_wake() causes suspend_device_irqs() to treat the given IRQ
> -in a special way.  Namely, the IRQ remains enabled, by on the first interrupt
> +in a special way.  Namely, the IRQ remains enabled, but on the first interrupt
>  it will be disabled, marked as pending and "suspended" so that it will be
>  re-enabled by resume_device_irqs() during the subsequent system resume.  Also
>  the PM core is notified about the event which causes the system suspend in
> -- 

Anyway, changes LGTM!

Reviewed-by: Dhruva Gole <d-gole@ti.com>

-- 
Best regards,
Dhruva Gole <d-gole@ti.com>