docs: man: Add description of 'calc_mode' and 'vcpu.<num>.megabytes_per_second' dirtyrate mode

[PATCH] docs: man: Add description of 'calc_mode' and 'vcpu.<num>.megabytes_per_second' dirtyrate mode

Peter Krempa posted 1 patch 2 years ago

Download mbox

Test syntax-check passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/7f8ccad543ab8705597b9c419b7ba7723f409858.1649766527.git.pkrempa@redhat.com

docs/manpages/virsh.rst | 4 ++++
1 file changed, 4 insertions(+)

Expand all Fold all

[PATCH] docs: man: Add description of 'calc_mode' and 'vcpu.<num>.megabytes_per_second' dirtyrate mode

Posted by Peter Krempa 2 years ago

Commit 42d36b65a31 added new fields to the API docs but didn't add the
virsh man page equivalent.

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=2073867
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/manpages/virsh.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index 588445028b..d7753c4970 100644
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -2505,6 +2505,10 @@ not available for statistical purposes.
   calculation.
 * ``dirtyrate.megabytes_per_second`` - the calculated memory dirty
   rate in MiB/s.
+* ``dirtyrate.calc_mode`` - the calculation mode used last measurement
+  (``page-sampling``/``dirty-bitmap``/``dirty-ring``)
+* ``dirtyrate.vcpu.<num>.megabytes_per_second`` - the calculated memory dirty
+  rate for a virtual cpu in MiB/s


 Selecting a specific statistics groups doesn't guarantee that the
-- 
2.35.1

Re: [PATCH] docs: man: Add description of 'calc_mode' and 'vcpu.<num>.megabytes_per_second' dirtyrate mode

Posted by Ján Tomko 2 years ago

On a Tuesday in 2022, Peter Krempa wrote:
>Commit 42d36b65a31 added new fields to the API docs but didn't add the
>virsh man page equivalent.
>
>Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=2073867
>Signed-off-by: Peter Krempa <pkrempa@redhat.com>
>---
> docs/manpages/virsh.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano