Documentation: PM: Clarify pm_runtime_resume_and_get() return value
authorPaul Barker <paul.barker.ct@bp.renesas.com>
Tue, 3 Dec 2024 14:37:29 +0000 (14:37 +0000)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tue, 10 Dec 2024 19:14:22 +0000 (20:14 +0100)
commitccb84dc8f4a02e7d30ffd388522996546b4d00e1
tree33271d47d4ad30de662b77f7ff4fef25f07cb452
parentfac04efc5c793dccbd07e2d59af9f90b7fc0dca4
Documentation: PM: Clarify pm_runtime_resume_and_get() return value

Update the documentation to match the behaviour of the code.

pm_runtime_resume_and_get() always returns 0 on success, even if
__pm_runtime_resume() returns 1.

Fixes: 2c412337cfe6 ("PM: runtime: Add documentation for pm_runtime_resume_and_get()")
Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Link: https://patch.msgid.link/20241203143729.478-1-paul.barker.ct@bp.renesas.com
[ rjw: Subject and changelog edits, adjusted new comment formatting ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/power/runtime_pm.rst