[libvirt] Man page patch for BZ 548485

[David Jorm]

Understood, I will re-implement and re-submit my patch tomorrow. Thanks for the info - this kind of detail in the BZ itself would be very useful for me. My job is just to document, i'm not a subject matter expert by any stretch.

----- Original Message -----
From: "Matthias Bolte" <matthias.bolte at googlemail.com>
To: "David Jorm" <djorm at redhat.com>
Cc: libvir-list at redhat.com
Sent: Thursday, January 14, 2010 8:02:39 PM GMT +10:00 Brisbane
Subject: Re: [libvirt] Man page patch for BZ 548485

2010/1/14 David Jorm <djorm at redhat.com>:
> See https://bugzilla.redhat.com/show_bug.cgi?id=548485
>
> git diff for the patch:
>
> ---SNIP---
>
> --- a/tools/virsh.pod
> +++ b/tools/virsh.pod
> @@ -342,7 +342,9 @@ severed upon restore, as TCP timeouts may have expired.
>
>  =item B<schedinfo> optional I<--weight> B<number> optional I<--cap> B<number> I<domain-id>
>
> -Allows to show (and set) the domain scheduler parameters.
> +Allows you to show (and set) the domain scheduler parameters.
> +
> +B<Note>: The only parameter currently available for all schedulers is cpu_shares. It has a valid value range of 0-262144.
>
>  B<Note>: The weight and cap parameters are defined only for the
>  XEN_CREDIT scheduler and are now I<DEPRECATED>.
>
> ---SNIP---
>
> I hope that's right, I found that BZ a bit confusing to comprehend. Learning curve.
>
> David
>

NACK.

cpu_shares is not available for all schedulers. The set of available
parameters and their valid ranges depends on the hypervisor:

LXC: type = posix, params = cpu_shares
Xen: type = credit, params = weight, cap
ESX: type = allocation, params = reservation, limit, shares
QEMU/KVM: type = posix, params = cpu_shares

Yes, documenting this properly isn't a simple task.

People complain about bad error messages In the bug report. They are
right, the error messages should be improved.

Matthias