[PATCH] docs/devel/reset.rst: Correct function names

Akihiko Odaki posted 1 patch 1 year, 5 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20221125140645.56490-1-akihiko.odaki@daynix.com
docs/devel/reset.rst | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
[PATCH] docs/devel/reset.rst: Correct function names
Posted by Akihiko Odaki 1 year, 5 months ago
resettable_class_set_parent_phases() was mistakenly called
resettable_class_set_parent_reset_phases() in some places.

Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
---
 docs/devel/reset.rst | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

diff --git a/docs/devel/reset.rst b/docs/devel/reset.rst
index 7cc6a6b314..38ed1790f7 100644
--- a/docs/devel/reset.rst
+++ b/docs/devel/reset.rst
@@ -184,21 +184,20 @@ in reset.
     {
         MyDevClass *myclass = MYDEV_CLASS(class);
         ResettableClass *rc = RESETTABLE_CLASS(class);
-        resettable_class_set_parent_reset_phases(rc,
-                                                 mydev_reset_enter,
-                                                 mydev_reset_hold,
-                                                 mydev_reset_exit,
-                                                 &myclass->parent_phases);
+        resettable_class_set_parent_phases(rc,
+                                           mydev_reset_enter,
+                                           mydev_reset_hold,
+                                           mydev_reset_exit,
+                                           &myclass->parent_phases);
     }
 
 In the above example, we override all three phases. It is possible to override
 only some of them by passing NULL instead of a function pointer to
-``resettable_class_set_parent_reset_phases()``. For example, the following will
+``resettable_class_set_parent_phases()``. For example, the following will
 only override the *enter* phase and leave *hold* and *exit* untouched::
 
-    resettable_class_set_parent_reset_phases(rc, mydev_reset_enter,
-                                             NULL, NULL,
-                                             &myclass->parent_phases);
+    resettable_class_set_parent_phases(rc, mydev_reset_enter, NULL, NULL,
+                                       &myclass->parent_phases);
 
 This is equivalent to providing a trivial implementation of the hold and exit
 phases which does nothing but call the parent class's implementation of the
-- 
2.38.1
Re: [PATCH] docs/devel/reset.rst: Correct function names
Posted by Akihiko Odaki 7 months, 1 week ago
On 2022/11/25 23:06, Akihiko Odaki wrote:
> resettable_class_set_parent_phases() was mistakenly called
> resettable_class_set_parent_reset_phases() in some places.
> 
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>   docs/devel/reset.rst | 17 ++++++++---------
>   1 file changed, 8 insertions(+), 9 deletions(-)
> 
> diff --git a/docs/devel/reset.rst b/docs/devel/reset.rst
> index 7cc6a6b314..38ed1790f7 100644
> --- a/docs/devel/reset.rst
> +++ b/docs/devel/reset.rst
> @@ -184,21 +184,20 @@ in reset.
>       {
>           MyDevClass *myclass = MYDEV_CLASS(class);
>           ResettableClass *rc = RESETTABLE_CLASS(class);
> -        resettable_class_set_parent_reset_phases(rc,
> -                                                 mydev_reset_enter,
> -                                                 mydev_reset_hold,
> -                                                 mydev_reset_exit,
> -                                                 &myclass->parent_phases);
> +        resettable_class_set_parent_phases(rc,
> +                                           mydev_reset_enter,
> +                                           mydev_reset_hold,
> +                                           mydev_reset_exit,
> +                                           &myclass->parent_phases);
>       }
>   
>   In the above example, we override all three phases. It is possible to override
>   only some of them by passing NULL instead of a function pointer to
> -``resettable_class_set_parent_reset_phases()``. For example, the following will
> +``resettable_class_set_parent_phases()``. For example, the following will
>   only override the *enter* phase and leave *hold* and *exit* untouched::
>   
> -    resettable_class_set_parent_reset_phases(rc, mydev_reset_enter,
> -                                             NULL, NULL,
> -                                             &myclass->parent_phases);
> +    resettable_class_set_parent_phases(rc, mydev_reset_enter, NULL, NULL,
> +                                       &myclass->parent_phases);
>   
>   This is equivalent to providing a trivial implementation of the hold and exit
>   phases which does nothing but call the parent class's implementation of the

Hi,

This patch seems to have been forgotten. Can anyone pull this?

Regards,
Akihiko Odaki
Re: [PATCH] docs/devel/reset.rst: Correct function names
Posted by Michael Tokarev 7 months, 1 week ago
21.09.2023 10:33, Akihiko Odaki:
..
> This patch seems to have been forgotten. Can anyone pull this?

Applied to my trivial-patches tree now.  Thank you!

/mjt
Re: [PATCH] docs/devel/reset.rst: Correct function names
Posted by Philippe Mathieu-Daudé 1 year, 4 months ago
On 25/11/22 15:06, Akihiko Odaki wrote:
> resettable_class_set_parent_phases() was mistakenly called
> resettable_class_set_parent_reset_phases() in some places.
> 
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>   docs/devel/reset.rst | 17 ++++++++---------
>   1 file changed, 8 insertions(+), 9 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>


Re: [PATCH] docs/devel/reset.rst: Correct function names
Posted by Peter Maydell 1 year, 5 months ago
On Fri, 25 Nov 2022 at 14:06, Akihiko Odaki <akihiko.odaki@daynix.com> wrote:
>
> resettable_class_set_parent_phases() was mistakenly called
> resettable_class_set_parent_reset_phases() in some places.
>
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>  docs/devel/reset.rst | 17 ++++++++---------
>  1 file changed, 8 insertions(+), 9 deletions(-)

Good catch; I think we renamed the function at some point
during code review of the resettable functionality, but
missed a few instances in the docs.

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

thanks
-- PMM
Re: [PATCH] docs/devel/reset.rst: Correct function names
Posted by Philippe Mathieu-Daudé 1 year, 5 months ago
On 25/11/22 15:06, Akihiko Odaki wrote:
> resettable_class_set_parent_phases() was mistakenly called
> resettable_class_set_parent_reset_phases() in some places.
> 
> Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
> ---
>   docs/devel/reset.rst | 17 ++++++++---------
>   1 file changed, 8 insertions(+), 9 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>