diff mbox

Fix docs for block stats monitor command

Message ID 1273746650-10518-1-git-send-email-berrange@redhat.com
State New
Headers show

Commit Message

Daniel P. Berrangé May 13, 2010, 10:30 a.m. UTC
The 'parent' field in the 'query-blockstats' monitor command is
part of the top level block device QDict, not part of the 2nd
level 'stats' QDict.

* block.c: Fix docs for 'parent' field in block stats monitor
  command output

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
---
 block.c |   23 +++++++++++------------
 1 files changed, 11 insertions(+), 12 deletions(-)

Comments

Kevin Wolf May 14, 2010, 8:15 a.m. UTC | #1
Am 13.05.2010 12:30, schrieb Daniel P. Berrange:
> The 'parent' field in the 'query-blockstats' monitor command is
> part of the top level block device QDict, not part of the 2nd
> level 'stats' QDict.
> 
> * block.c: Fix docs for 'parent' field in block stats monitor
>   command output
> 
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

Oops, you're right of course.

Luiz, there was this patch that moved all the documentation to a
different place and will conflict with this one. Should we fix the
documentation on top of your patch or are you going to rebase?

Kevin
Luiz Capitulino May 14, 2010, 2:05 p.m. UTC | #2
On Fri, 14 May 2010 10:15:32 +0200
Kevin Wolf <kwolf@redhat.com> wrote:

> Am 13.05.2010 12:30, schrieb Daniel P. Berrange:
> > The 'parent' field in the 'query-blockstats' monitor command is
> > part of the top level block device QDict, not part of the 2nd
> > level 'stats' QDict.
> > 
> > * block.c: Fix docs for 'parent' field in block stats monitor
> >   command output
> > 
> > Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> 
> Oops, you're right of course.
> 
> Luiz, there was this patch that moved all the documentation to a
> different place and will conflict with this one. Should we fix the
> documentation on top of your patch or are you going to rebase?

 I'm going to rebase, have lots of stuff to fix in the doc.
Kevin Wolf May 14, 2010, 2:10 p.m. UTC | #3
Am 14.05.2010 16:05, schrieb Luiz Capitulino:
> On Fri, 14 May 2010 10:15:32 +0200
> Kevin Wolf <kwolf@redhat.com> wrote:
> 
>> Am 13.05.2010 12:30, schrieb Daniel P. Berrange:
>>> The 'parent' field in the 'query-blockstats' monitor command is
>>> part of the top level block device QDict, not part of the 2nd
>>> level 'stats' QDict.
>>>
>>> * block.c: Fix docs for 'parent' field in block stats monitor
>>>   command output
>>>
>>> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
>>
>> Oops, you're right of course.
>>
>> Luiz, there was this patch that moved all the documentation to a
>> different place and will conflict with this one. Should we fix the
>> documentation on top of your patch or are you going to rebase?
> 
>  I'm going to rebase, have lots of stuff to fix in the doc.

Alright, applied the patch to the block branch then.

Kevin
diff mbox

Patch

diff --git a/block.c b/block.c
index 48305b7..90f7b47 100644
--- a/block.c
+++ b/block.c
@@ -1580,9 +1580,9 @@  static QObject* bdrv_info_stats_bs(BlockDriverState *bs)
  *     - "wr_operations": write operations
  *     - "wr_highest_offset": Highest offset of a sector written since the
  *       BlockDriverState has been opened
- *     - "parent": Contains recursively the statistics of the underlying
- *       protocol (e.g. the host file for a qcow2 image). If there is no
- *       underlying protocol, this field is omitted.
+ * - "parent": A QDict recursively holding the statistics of the underlying
+ *    protocol (e.g. the host file for a qcow2 image). If there is no
+ *    underlying protocol, this field is omitted.
  *
  * Example:
  *
@@ -1591,15 +1591,14 @@  static QObject* bdrv_info_stats_bs(BlockDriverState *bs)
  *                          "wr_bytes": 0,
  *                          "rd_operations": 1,
  *                          "wr_operations": 0,
- *                          "wr_highest_offset": 0,
- *                          "parent": {
- *                              "stats": { "rd_bytes": 1024,
- *                                         "wr_bytes": 0,
- *                                         "rd_operations": 2,
- *                                         "wr_operations": 0,
- *                                         "wr_highest_offset": 0,
- *                              }
- *                          } } },
+ *                          "wr_highest_offset": 0 },
+ *               "parent": {
+ *                      "stats": { "rd_bytes": 1024,
+ *                                 "wr_bytes": 0,
+ *                                 "rd_operations": 2,
+ *                                 "wr_operations": 0,
+ *                                 "wr_highest_offset": 0,
+ *                      } } },
  *   { "device": "ide1-cd0",
  *               "stats": { "rd_bytes": 0,
  *                          "wr_bytes": 0,