qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
* [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment
@ 2020-07-29 19:10 Peter Maydell
  2020-07-29 19:24 ` Eric Blake
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Peter Maydell @ 2020-07-29 19:10 UTC (permalink / raw)
  To: qemu-devel; +Cc: Eduardo Habkost, Markus Armbruster

In commit 176d2cda0dee9f4 we added the @die-id field
to the CpuInstanceProperties struct, but in the process
accidentally removed the newline between the doc-comment
lines for @core-id and @thread-id.

Put the newline back in; this fixes a misformatting in the
generated HTML QMP reference manual.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Not very important but I've suggested for-5.1 as it's a safe
docs fix. You can see the misrendered doc at
https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#index-CpuInstanceProperties

 qapi/machine.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index f59144023ca..daede5ab149 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -825,7 +825,8 @@
 # @node-id: NUMA node ID the CPU belongs to
 # @socket-id: socket number within node/board the CPU belongs to
 # @die-id: die number within node/board the CPU belongs to (Since 4.1)
-# @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
+# @core-id: core number within die the CPU belongs to
+# @thread-id: thread number within core the CPU belongs to
 #
 # Note: currently there are 5 properties that could be present
 #       but management should be prepared to pass through other
-- 
2.20.1



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

* Re: [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment
  2020-07-29 19:10 [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment Peter Maydell
@ 2020-07-29 19:24 ` Eric Blake
  2020-07-29 19:48 ` Philippe Mathieu-Daudé
  2020-07-30  9:21 ` Markus Armbruster
  2 siblings, 0 replies; 5+ messages in thread
From: Eric Blake @ 2020-07-29 19:24 UTC (permalink / raw)
  To: Peter Maydell, qemu-devel; +Cc: Eduardo Habkost, Markus Armbruster

On 7/29/20 2:10 PM, Peter Maydell wrote:
> In commit 176d2cda0dee9f4 we added the @die-id field
> to the CpuInstanceProperties struct, but in the process
> accidentally removed the newline between the doc-comment
> lines for @core-id and @thread-id.
> 
> Put the newline back in; this fixes a misformatting in the
> generated HTML QMP reference manual.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Not very important but I've suggested for-5.1 as it's a safe
> docs fix. You can see the misrendered doc at
> https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#index-CpuInstanceProperties

Reviewed-by: Eric Blake <eblake@redhat.com>

> 
>   qapi/machine.json | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/qapi/machine.json b/qapi/machine.json
> index f59144023ca..daede5ab149 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -825,7 +825,8 @@
>   # @node-id: NUMA node ID the CPU belongs to
>   # @socket-id: socket number within node/board the CPU belongs to
>   # @die-id: die number within node/board the CPU belongs to (Since 4.1)
> -# @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
> +# @core-id: core number within die the CPU belongs to
> +# @thread-id: thread number within core the CPU belongs to
>   #
>   # Note: currently there are 5 properties that could be present
>   #       but management should be prepared to pass through other
> 

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org



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

* Re: [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment
  2020-07-29 19:10 [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment Peter Maydell
  2020-07-29 19:24 ` Eric Blake
@ 2020-07-29 19:48 ` Philippe Mathieu-Daudé
  2020-07-30  9:21 ` Markus Armbruster
  2 siblings, 0 replies; 5+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-07-29 19:48 UTC (permalink / raw)
  To: Peter Maydell, qemu-devel; +Cc: Eduardo Habkost, Markus Armbruster

On 7/29/20 9:10 PM, Peter Maydell wrote:
> In commit 176d2cda0dee9f4 we added the @die-id field
> to the CpuInstanceProperties struct, but in the process
> accidentally removed the newline between the doc-comment
> lines for @core-id and @thread-id.
> 
> Put the newline back in; this fixes a misformatting in the
> generated HTML QMP reference manual.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Not very important but I've suggested for-5.1 as it's a safe
> docs fix. You can see the misrendered doc at
> https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#index-CpuInstanceProperties
> 
>  qapi/machine.json | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/qapi/machine.json b/qapi/machine.json
> index f59144023ca..daede5ab149 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -825,7 +825,8 @@
>  # @node-id: NUMA node ID the CPU belongs to
>  # @socket-id: socket number within node/board the CPU belongs to
>  # @die-id: die number within node/board the CPU belongs to (Since 4.1)
> -# @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
> +# @core-id: core number within die the CPU belongs to
> +# @thread-id: thread number within core the CPU belongs to
>  #
>  # Note: currently there are 5 properties that could be present
>  #       but management should be prepared to pass through other
> 

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>



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

* Re: [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment
  2020-07-29 19:10 [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment Peter Maydell
  2020-07-29 19:24 ` Eric Blake
  2020-07-29 19:48 ` Philippe Mathieu-Daudé
@ 2020-07-30  9:21 ` Markus Armbruster
  2 siblings, 0 replies; 5+ messages in thread
From: Markus Armbruster @ 2020-07-30  9:21 UTC (permalink / raw)
  To: Peter Maydell; +Cc: qemu-devel, Eduardo Habkost

Peter Maydell <peter.maydell@linaro.org> writes:

> In commit 176d2cda0dee9f4 we added the @die-id field
> to the CpuInstanceProperties struct, but in the process
> accidentally removed the newline between the doc-comment
> lines for @core-id and @thread-id.
>
> Put the newline back in; this fixes a misformatting in the
> generated HTML QMP reference manual.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Not very important but I've suggested for-5.1 as it's a safe
> docs fix. You can see the misrendered doc at
> https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#index-CpuInstanceProperties

Makes sense.

Queued, thanks!



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

* [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment
  2020-10-12 15:33 [PATCH 00/10] target/arm: Various v8.1M minor features Peter Maydell
@ 2020-10-12 15:33 ` Peter Maydell
  0 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2020-10-12 15:33 UTC (permalink / raw)
  To: qemu-arm, qemu-devel; +Cc: Richard Henderson

In commit 176d2cda0dee9f4 we added the @die-id field
to the CpuInstanceProperties struct, but in the process
accidentally removed the newline between the doc-comment
lines for @core-id and @thread-id.

Put the newline back in; this fixes a misformatting in the
generated HTML QMP reference manual.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Not very important but I've suggested for-5.1 as it's a safe
docs fix. You can see the misrendered doc at
https://www.qemu.org/docs/master/interop/qemu-qmp-ref.html#index-CpuInstanceProperties

 qapi/machine.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index f59144023ca..daede5ab149 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -825,7 +825,8 @@
 # @node-id: NUMA node ID the CPU belongs to
 # @socket-id: socket number within node/board the CPU belongs to
 # @die-id: die number within node/board the CPU belongs to (Since 4.1)
-# @core-id: core number within die the CPU belongs to# @thread-id: thread number within core the CPU belongs to
+# @core-id: core number within die the CPU belongs to
+# @thread-id: thread number within core the CPU belongs to
 #
 # Note: currently there are 5 properties that could be present
 #       but management should be prepared to pass through other
-- 
2.20.1



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

end of thread, other threads:[~2020-10-12 15:47 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-07-29 19:10 [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment Peter Maydell
2020-07-29 19:24 ` Eric Blake
2020-07-29 19:48 ` Philippe Mathieu-Daudé
2020-07-30  9:21 ` Markus Armbruster
  -- strict thread matches above, loose matches on Subject: below --
2020-10-12 15:33 [PATCH 00/10] target/arm: Various v8.1M minor features Peter Maydell
2020-10-12 15:33 ` [PATCH for-5.1] qapi/machine.json: Fix missing newline in doc comment Peter Maydell

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).