All of lore.kernel.org
 help / color / mirror / Atom feed
* Note improvements to QAPI-generated manuals in ChangeLog/10.0?
@ 2025-04-09 13:44 Markus Armbruster
  2025-04-09 14:18 ` Stefan Hajnoczi
  0 siblings, 1 reply; 4+ messages in thread
From: Markus Armbruster @ 2025-04-09 13:44 UTC (permalink / raw)
  To: qemu-devel; +Cc: Stefan Hajnoczi, Peter Maydell, John Snow

John improved looks and usabilibity of the QAPI-generated manuals quite
a bit.  These are

    QEMU QMP Reference Manual
    QEMU Storage Daemon QMP Reference Manual
    QEMU Guest Agent Protocol Reference

Where should it go?  https://wiki.qemu.org/ChangeLog/10.0 has no section
dedicated to the manuals.  We could mention it under System Emulation /
Monitor / QMP, and again under Guest Agent.  Thoughts?



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Note improvements to QAPI-generated manuals in ChangeLog/10.0?
  2025-04-09 13:44 Note improvements to QAPI-generated manuals in ChangeLog/10.0? Markus Armbruster
@ 2025-04-09 14:18 ` Stefan Hajnoczi
  2025-04-10  4:53   ` Markus Armbruster
  0 siblings, 1 reply; 4+ messages in thread
From: Stefan Hajnoczi @ 2025-04-09 14:18 UTC (permalink / raw)
  To: Markus Armbruster; +Cc: qemu-devel, Stefan Hajnoczi, Peter Maydell, John Snow

On Wed, Apr 9, 2025 at 9:44 AM Markus Armbruster <armbru@redhat.com> wrote:
>
> John improved looks and usabilibity of the QAPI-generated manuals quite
> a bit.  These are
>
>     QEMU QMP Reference Manual
>     QEMU Storage Daemon QMP Reference Manual
>     QEMU Guest Agent Protocol Reference
>
> Where should it go?  https://wiki.qemu.org/ChangeLog/10.0 has no section
> dedicated to the manuals.  We could mention it under System Emulation /
> Monitor / QMP, and again under Guest Agent.  Thoughts?

I would add a separate Documentation section for changes like this.
That's also where major docs infrastructure items like changes to
formats (rST), tooling (Sphinx), etc could be announced.

Stefan


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Note improvements to QAPI-generated manuals in ChangeLog/10.0?
  2025-04-09 14:18 ` Stefan Hajnoczi
@ 2025-04-10  4:53   ` Markus Armbruster
  2025-04-10 13:06     ` Stefan Hajnoczi
  0 siblings, 1 reply; 4+ messages in thread
From: Markus Armbruster @ 2025-04-10  4:53 UTC (permalink / raw)
  To: Stefan Hajnoczi; +Cc: qemu-devel, Stefan Hajnoczi, Peter Maydell, John Snow

Stefan Hajnoczi <stefanha@gmail.com> writes:

> On Wed, Apr 9, 2025 at 9:44 AM Markus Armbruster <armbru@redhat.com> wrote:
>>
>> John improved looks and usabilibity of the QAPI-generated manuals quite
>> a bit.  These are
>>
>>     QEMU QMP Reference Manual
>>     QEMU Storage Daemon QMP Reference Manual
>>     QEMU Guest Agent Protocol Reference
>>
>> Where should it go?  https://wiki.qemu.org/ChangeLog/10.0 has no section
>> dedicated to the manuals.  We could mention it under System Emulation /
>> Monitor / QMP, and again under Guest Agent.  Thoughts?
>
> I would add a separate Documentation section for changes like this.
> That's also where major docs infrastructure items like changes to
> formats (rST), tooling (Sphinx), etc could be announced.

Insert a "Documentation" section between "Guest agent" and "Build
Information"?



^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: Note improvements to QAPI-generated manuals in ChangeLog/10.0?
  2025-04-10  4:53   ` Markus Armbruster
@ 2025-04-10 13:06     ` Stefan Hajnoczi
  0 siblings, 0 replies; 4+ messages in thread
From: Stefan Hajnoczi @ 2025-04-10 13:06 UTC (permalink / raw)
  To: Markus Armbruster; +Cc: Stefan Hajnoczi, qemu-devel, Peter Maydell, John Snow

[-- Attachment #1: Type: text/plain, Size: 1007 bytes --]

On Thu, Apr 10, 2025 at 06:53:53AM +0200, Markus Armbruster wrote:
> Stefan Hajnoczi <stefanha@gmail.com> writes:
> 
> > On Wed, Apr 9, 2025 at 9:44 AM Markus Armbruster <armbru@redhat.com> wrote:
> >>
> >> John improved looks and usabilibity of the QAPI-generated manuals quite
> >> a bit.  These are
> >>
> >>     QEMU QMP Reference Manual
> >>     QEMU Storage Daemon QMP Reference Manual
> >>     QEMU Guest Agent Protocol Reference
> >>
> >> Where should it go?  https://wiki.qemu.org/ChangeLog/10.0 has no section
> >> dedicated to the manuals.  We could mention it under System Emulation /
> >> Monitor / QMP, and again under Guest Agent.  Thoughts?
> >
> > I would add a separate Documentation section for changes like this.
> > That's also where major docs infrastructure items like changes to
> > formats (rST), tooling (Sphinx), etc could be announced.
> 
> Insert a "Documentation" section between "Guest agent" and "Build
> Information"?

Sounds good to me.

Stefan

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-04-10 13:07 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-04-09 13:44 Note improvements to QAPI-generated manuals in ChangeLog/10.0? Markus Armbruster
2025-04-09 14:18 ` Stefan Hajnoczi
2025-04-10  4:53   ` Markus Armbruster
2025-04-10 13:06     ` Stefan Hajnoczi

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.