diff mbox series

[qemu.git,1/1] docs/devel/reset: add missing words

Message ID 172998683323.20070.572834413126431721-1@git.sr.ht
State New
Headers show
Series docs/devel/reset: add missing words | expand

Commit Message

~axelheider Oct. 17, 2024, 5:58 p.m. UTC
From: Axel Heider <axel.heider@codasip.com>

Signed-off-by: Axel Heider <axel.heider@codasip.com>
---
 docs/devel/reset.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Manos Pitsidianakis Oct. 27, 2024, 10:02 a.m. UTC | #1
Hello Axel,

On Thu, 17 Oct 2024 20:58, ~axelheider <axelheider@git.sr.ht> wrote:
>From: Axel Heider <axel.heider@codasip.com>
>
>Signed-off-by: Axel Heider <axel.heider@codasip.com>
>---
> docs/devel/reset.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>diff --git a/docs/devel/reset.rst b/docs/devel/reset.rst
>index 74c7c0171a..3e64a7259f 100644
>--- a/docs/devel/reset.rst
>+++ b/docs/devel/reset.rst
>@@ -286,7 +286,7 @@ every reset child of the given resettable object. All children must be
> resettable too. Additional parameters (a reset type and an opaque pointer) must
> be passed to the callback too.
> 
>-In ``DeviceClass`` and ``BusClass`` the ``ResettableState`` is located
>+In ``DeviceClass`` and ``BusClass`` the ``ResettableState`` is located in the
> ``DeviceState`` and ``BusState`` structure. ``child_foreach()`` is implemented
> to follow the bus hierarchy; for a bus, it calls the function on every child
> device; for a device, it calls the function on every bus child. When we reset
>-- 
>2.45.2
>

FYI: the `[PATCH ...]` part of the patch subject does not need the 
`qemu.git` string inside it, I suspect it was added by some tooling you 
were using however.

If you decide to spin this patch in a new version I suggest also making 
this separate change: (adding a plural `s` suffix at `structure`)

- ``DeviceState`` and ``BusState`` structure. ``child_foreach()`` is implemented
+ ``DeviceState`` and ``BusState`` structures. ``child_foreach()`` is implemented


Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
diff mbox series

Patch

diff --git a/docs/devel/reset.rst b/docs/devel/reset.rst
index 74c7c0171a..3e64a7259f 100644
--- a/docs/devel/reset.rst
+++ b/docs/devel/reset.rst
@@ -286,7 +286,7 @@  every reset child of the given resettable object. All children must be
 resettable too. Additional parameters (a reset type and an opaque pointer) must
 be passed to the callback too.
 
-In ``DeviceClass`` and ``BusClass`` the ``ResettableState`` is located
+In ``DeviceClass`` and ``BusClass`` the ``ResettableState`` is located in the
 ``DeviceState`` and ``BusState`` structure. ``child_foreach()`` is implemented
 to follow the bus hierarchy; for a bus, it calls the function on every child
 device; for a device, it calls the function on every bus child. When we reset