[PATCH 0/2] qapi-domain: Typos and MAINTAINERS

[PATCH 0/2] qapi-domain: Typos and MAINTAINERS

[Markus Armbruster]

Markus Armbruster (2):
  docs/qapi-domain: Fix typos
  MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

 MAINTAINERS                | 1 +
 docs/devel/qapi-domain.rst | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)

-- 
2.49.0

[PATCH 1/2] docs/qapi-domain: Fix typos

[Markus Armbruster]

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/devel/qapi-domain.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst
index b71890f660..fe540d1e40 100644
--- a/docs/devel/qapi-domain.rst
+++ b/docs/devel/qapi-domain.rst
@@ -9,7 +9,7 @@ in Sphinx is provided by the QAPI Domain, located in
 `Python Domain
 <https://www.sphinx-doc.org/en/master/usage/domains/python.html>`_
 included with Sphinx, but provides special directives and roles
-speciically for annotating and documenting QAPI definitions
+for annotating and documenting QAPI definitions
 specifically.
 
 A `Domain
@@ -101,7 +101,7 @@ without types. The QAPI domain uses this class for features, returns,
 and enum values.
 
 TypedField:
-  * Creates a grouped, typed field. Multiple adjacent entres will be
+  * Creates a grouped, typed field. Multiple adjacent entries will be
     merged into one section, and the content will form a bulleted list.
   * *Must* take at least one argument, but supports up to two -
     nominally, a name and a type.
-- 
2.49.0

Re: [PATCH 1/2] docs/qapi-domain: Fix typos

[Manos Pitsidianakis]

On Tue, Jul 29, 2025 at 12:17 PM Markus Armbruster <armbru@redhat.com> wrote:
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  docs/devel/qapi-domain.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst
> index b71890f660..fe540d1e40 100644
> --- a/docs/devel/qapi-domain.rst
> +++ b/docs/devel/qapi-domain.rst
> @@ -9,7 +9,7 @@ in Sphinx is provided by the QAPI Domain, located in
>  `Python Domain
>  <https://www.sphinx-doc.org/en/master/usage/domains/python.html>`_
>  included with Sphinx, but provides special directives and roles
> -speciically for annotating and documenting QAPI definitions
> +for annotating and documenting QAPI definitions
>  specifically.
>
>  A `Domain
> @@ -101,7 +101,7 @@ without types. The QAPI domain uses this class for features, returns,
>  and enum values.
>
>  TypedField:
> -  * Creates a grouped, typed field. Multiple adjacent entres will be
> +  * Creates a grouped, typed field. Multiple adjacent entries will be
>      merged into one section, and the content will form a bulleted list.
>    * *Must* take at least one argument, but supports up to two -
>      nominally, a name and a type.
> --
> 2.49.0
>
>

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

[PATCH 2/2] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

[Markus Armbruster]

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 MAINTAINERS | 1 +
 1 file changed, 1 insertion(+)

diff --git a/MAINTAINERS b/MAINTAINERS
index f1bd69c3db..9c22e921e8 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4432,6 +4432,7 @@ F: docs/requirements.txt
 F: docs/sphinx/
 F: docs/_templates/
 F: docs/devel/docs.rst
+F: docs/devel/qapi-domain.rst
 
 Rust build system integration
 M: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
-- 
2.49.0

Re: [PATCH 2/2] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

[Manos Pitsidianakis]

On Tue, Jul 29, 2025 at 12:18 PM Markus Armbruster <armbru@redhat.com> wrote:
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  MAINTAINERS | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index f1bd69c3db..9c22e921e8 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -4432,6 +4432,7 @@ F: docs/requirements.txt
>  F: docs/sphinx/
>  F: docs/_templates/
>  F: docs/devel/docs.rst
> +F: docs/devel/qapi-domain.rst

Question: Does it matter if this is already covered by QAPI section
which has: "F: docs/devel/qapi*"?

If not,

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

>
>  Rust build system integration
>  M: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> --
> 2.49.0
>
>

Re: [PATCH 2/2] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

[Markus Armbruster]

Manos Pitsidianakis <manos.pitsidianakis@linaro.org> writes:

> On Tue, Jul 29, 2025 at 12:18 PM Markus Armbruster <armbru@redhat.com> wrote:
>>
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>  MAINTAINERS | 1 +
>>  1 file changed, 1 insertion(+)
>>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index f1bd69c3db..9c22e921e8 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -4432,6 +4432,7 @@ F: docs/requirements.txt
>>  F: docs/sphinx/
>>  F: docs/_templates/
>>  F: docs/devel/docs.rst
>> +F: docs/devel/qapi-domain.rst
>
> Question: Does it matter if this is already covered by QAPI section
> which has: "F: docs/devel/qapi*"?

I'm adding it to the "Sphinx documentation configuration and build
machinery" section as well.

Before the patch:

    $ scripts/get_maintainer.pl -f docs/devel/qapi-domain.rst 
    Markus Armbruster <armbru@redhat.com> (supporter:QAPI)
    Michael Roth <michael.roth@amd.com> (supporter:QAPI)
    qemu-devel@nongnu.org (open list:All patches CC here)

Afterwards:

    $ scripts/get_maintainer.pl -f docs/devel/qapi-domain.rst 
--> John Snow <jsnow@redhat.com> (maintainer:Sphinx documentat...)
--> Peter Maydell <peter.maydell@linaro.org> (maintainer:Sphinx documentat...)
    Markus Armbruster <armbru@redhat.com> (supporter:QAPI)
    Michael Roth <michael.roth@amd.com> (supporter:QAPI)
    qemu-devel@nongnu.org (open list:All patches CC here)

Good, because it's John's baby, and he's maintaining it.

> If not,
>
> Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

Thank you!

[...]

Re: [PATCH 2/2] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

[Markus Armbruster]

Markus Armbruster <armbru@redhat.com> writes:

> Manos Pitsidianakis <manos.pitsidianakis@linaro.org> writes:
>
>> On Tue, Jul 29, 2025 at 12:18 PM Markus Armbruster <armbru@redhat.com> wrote:
>>>
>>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>>> ---
>>>  MAINTAINERS | 1 +
>>>  1 file changed, 1 insertion(+)
>>>
>>> diff --git a/MAINTAINERS b/MAINTAINERS
>>> index f1bd69c3db..9c22e921e8 100644
>>> --- a/MAINTAINERS
>>> +++ b/MAINTAINERS
>>> @@ -4432,6 +4432,7 @@ F: docs/requirements.txt
>>>  F: docs/sphinx/
>>>  F: docs/_templates/
>>>  F: docs/devel/docs.rst
>>> +F: docs/devel/qapi-domain.rst
>>
>> Question: Does it matter if this is already covered by QAPI section
>> which has: "F: docs/devel/qapi*"?
>
> I'm adding it to the "Sphinx documentation configuration and build
> machinery" section as well.
>
> Before the patch:
>
>     $ scripts/get_maintainer.pl -f docs/devel/qapi-domain.rst 
>     Markus Armbruster <armbru@redhat.com> (supporter:QAPI)
>     Michael Roth <michael.roth@amd.com> (supporter:QAPI)
>     qemu-devel@nongnu.org (open list:All patches CC here)
>
> Afterwards:
>
>     $ scripts/get_maintainer.pl -f docs/devel/qapi-domain.rst 
> --> John Snow <jsnow@redhat.com> (maintainer:Sphinx documentat...)
> --> Peter Maydell <peter.maydell@linaro.org> (maintainer:Sphinx documentat...)
>     Markus Armbruster <armbru@redhat.com> (supporter:QAPI)
>     Michael Roth <michael.roth@amd.com> (supporter:QAPI)
>     qemu-devel@nongnu.org (open list:All patches CC here)
>
> Good, because it's John's baby, and he's maintaining it.
>
>> If not,
>>
>> Reviewed-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
>
> Thank you!
>
> [...]

Amending the commit message:

    Section QAPI already covers it, and that's fine.  It's missing from
    "Sphinx documentation configuration and build machinery".  Add it
    there.

Re: [PATCH 2/2] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly

[Philippe Mathieu-Daudé]

On 29/7/25 11:16, Markus Armbruster wrote:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   MAINTAINERS | 1 +
>   1 file changed, 1 insertion(+)

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

Re: [PATCH 0/2] qapi-domain: Typos and MAINTAINERS

[Markus Armbruster]

Queued.  Thanks for the review!