[PATCH] PM: runtime: Fix typos and grammar

[PATCH] PM: runtime: Fix typos and grammar

[Bjorn Helgaas]

From: Bjorn Helgaas <bhelgaas@google.com>

Fix minor typos and grammatical issues.

Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
---
 Documentation/power/runtime_pm.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/Documentation/power/runtime_pm.rst b/Documentation/power/runtime_pm.rst
index 0553008b6279..d9c777b18f7a 100644
--- a/Documentation/power/runtime_pm.rst
+++ b/Documentation/power/runtime_pm.rst
@@ -579,7 +579,7 @@ should be used.  Of course, for this purpose the device's runtime PM has to be
 enabled earlier by calling pm_runtime_enable().
 
 Note, if the device may execute pm_runtime calls during the probe (such as
-if it is registers with a subsystem that may call back in) then the
+if it is registered with a subsystem that may call back in) then the
 pm_runtime_get_sync() call paired with a pm_runtime_put() call will be
 appropriate to ensure that the device is not put back to sleep during the
 probe. This can happen with systems such as the network device layer.
@@ -587,11 +587,11 @@ probe. This can happen with systems such as the network device layer.
 It may be desirable to suspend the device once ->probe() has finished.
 Therefore the driver core uses the asynchronous pm_request_idle() to submit a
 request to execute the subsystem-level idle callback for the device at that
-time.  A driver that makes use of the runtime autosuspend feature, may want to
+time.  A driver that makes use of the runtime autosuspend feature may want to
 update the last busy mark before returning from ->probe().
 
 Moreover, the driver core prevents runtime PM callbacks from racing with the bus
-notifier callback in __device_release_driver(), which is necessary, because the
+notifier callback in __device_release_driver(), which is necessary because the
 notifier is used by some subsystems to carry out operations affecting the
 runtime PM functionality.  It does so by calling pm_runtime_get_sync() before
 driver_sysfs_remove() and the BUS_NOTIFY_UNBIND_DRIVER notifications.  This
@@ -603,7 +603,7 @@ calling pm_runtime_suspend() from their ->remove() routines, the driver core
 executes pm_runtime_put_sync() after running the BUS_NOTIFY_UNBIND_DRIVER
 notifications in __device_release_driver().  This requires bus types and
 drivers to make their ->remove() callbacks avoid races with runtime PM directly,
-but also it allows of more flexibility in the handling of devices during the
+but it also allows more flexibility in the handling of devices during the
 removal of their drivers.
 
 Drivers in ->remove() callback should undo the runtime PM changes done
@@ -693,7 +693,7 @@ that the device appears to be runtime-suspended and its state is fine, so it
 may be left in runtime suspend provided that all of its descendants are also
 left in runtime suspend.  If that happens, the PM core will not execute any
 system suspend and resume callbacks for all of those devices, except for the
-complete callback, which is then entirely responsible for handling the device
+.complete() callback, which is then entirely responsible for handling the device
 as appropriate.  This only applies to system suspend transitions that are not
 related to hibernation (see Documentation/driver-api/pm/devices.rst for more
 information).
@@ -706,7 +706,7 @@ out the following operations:
     right before executing the subsystem-level .prepare() callback for it and
     pm_runtime_barrier() is called for every device right before executing the
     subsystem-level .suspend() callback for it.  In addition to that the PM core
-    calls  __pm_runtime_disable() with 'false' as the second argument for every
+    calls __pm_runtime_disable() with 'false' as the second argument for every
     device right before executing the subsystem-level .suspend_late() callback
     for it.
 
@@ -783,7 +783,7 @@ driver/base/power/generic_ops.c:
   `int pm_generic_restore_noirq(struct device *dev);`
     - invoke the ->restore_noirq() callback provided by the device's driver
 
-These functions are the defaults used by the PM core, if a subsystem doesn't
+These functions are the defaults used by the PM core if a subsystem doesn't
 provide its own callbacks for ->runtime_idle(), ->runtime_suspend(),
 ->runtime_resume(), ->suspend(), ->suspend_noirq(), ->resume(),
 ->resume_noirq(), ->freeze(), ->freeze_noirq(), ->thaw(), ->thaw_noirq(),
-- 
2.25.1

Re: [PATCH] PM: runtime: Fix typos and grammar

[Rafael J. Wysocki]

On Wed, Jan 27, 2021 at 8:23 AM Bjorn Helgaas <helgaas@kernel.org> wrote:
>
> From: Bjorn Helgaas <bhelgaas@google.com>
>
> Fix minor typos and grammatical issues.
>
> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>

Applied as 5.12 material, thanks!

> ---
>  Documentation/power/runtime_pm.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/power/runtime_pm.rst b/Documentation/power/runtime_pm.rst
> index 0553008b6279..d9c777b18f7a 100644
> --- a/Documentation/power/runtime_pm.rst
> +++ b/Documentation/power/runtime_pm.rst
> @@ -579,7 +579,7 @@ should be used.  Of course, for this purpose the device's runtime PM has to be
>  enabled earlier by calling pm_runtime_enable().
>
>  Note, if the device may execute pm_runtime calls during the probe (such as
> -if it is registers with a subsystem that may call back in) then the
> +if it is registered with a subsystem that may call back in) then the
>  pm_runtime_get_sync() call paired with a pm_runtime_put() call will be
>  appropriate to ensure that the device is not put back to sleep during the
>  probe. This can happen with systems such as the network device layer.
> @@ -587,11 +587,11 @@ probe. This can happen with systems such as the network device layer.
>  It may be desirable to suspend the device once ->probe() has finished.
>  Therefore the driver core uses the asynchronous pm_request_idle() to submit a
>  request to execute the subsystem-level idle callback for the device at that
> -time.  A driver that makes use of the runtime autosuspend feature, may want to
> +time.  A driver that makes use of the runtime autosuspend feature may want to
>  update the last busy mark before returning from ->probe().
>
>  Moreover, the driver core prevents runtime PM callbacks from racing with the bus
> -notifier callback in __device_release_driver(), which is necessary, because the
> +notifier callback in __device_release_driver(), which is necessary because the
>  notifier is used by some subsystems to carry out operations affecting the
>  runtime PM functionality.  It does so by calling pm_runtime_get_sync() before
>  driver_sysfs_remove() and the BUS_NOTIFY_UNBIND_DRIVER notifications.  This
> @@ -603,7 +603,7 @@ calling pm_runtime_suspend() from their ->remove() routines, the driver core
>  executes pm_runtime_put_sync() after running the BUS_NOTIFY_UNBIND_DRIVER
>  notifications in __device_release_driver().  This requires bus types and
>  drivers to make their ->remove() callbacks avoid races with runtime PM directly,
> -but also it allows of more flexibility in the handling of devices during the
> +but it also allows more flexibility in the handling of devices during the
>  removal of their drivers.
>
>  Drivers in ->remove() callback should undo the runtime PM changes done
> @@ -693,7 +693,7 @@ that the device appears to be runtime-suspended and its state is fine, so it
>  may be left in runtime suspend provided that all of its descendants are also
>  left in runtime suspend.  If that happens, the PM core will not execute any
>  system suspend and resume callbacks for all of those devices, except for the
> -complete callback, which is then entirely responsible for handling the device
> +.complete() callback, which is then entirely responsible for handling the device
>  as appropriate.  This only applies to system suspend transitions that are not
>  related to hibernation (see Documentation/driver-api/pm/devices.rst for more
>  information).
> @@ -706,7 +706,7 @@ out the following operations:
>      right before executing the subsystem-level .prepare() callback for it and
>      pm_runtime_barrier() is called for every device right before executing the
>      subsystem-level .suspend() callback for it.  In addition to that the PM core
> -    calls  __pm_runtime_disable() with 'false' as the second argument for every
> +    calls __pm_runtime_disable() with 'false' as the second argument for every
>      device right before executing the subsystem-level .suspend_late() callback
>      for it.
>
> @@ -783,7 +783,7 @@ driver/base/power/generic_ops.c:
>    `int pm_generic_restore_noirq(struct device *dev);`
>      - invoke the ->restore_noirq() callback provided by the device's driver
>
> -These functions are the defaults used by the PM core, if a subsystem doesn't
> +These functions are the defaults used by the PM core if a subsystem doesn't
>  provide its own callbacks for ->runtime_idle(), ->runtime_suspend(),
>  ->runtime_resume(), ->suspend(), ->suspend_noirq(), ->resume(),
>  ->resume_noirq(), ->freeze(), ->freeze_noirq(), ->thaw(), ->thaw_noirq(),
> --
> 2.25.1
>