[libvirt] [PATCH 2/2] docs: formatdomain: clarify period cputune subelement

[Katerina Koukiou]

On Wed, Jul 18, 2018 at 10:05:30AM +0200, Ján Tomko wrote:
> On Tue, Jul 17, 2018 at 05:47:32PM +0200, Katerina Koukiou wrote:
> > Although the name of the element is not self-explanatory,
> > it's affecting only the vcpu threads.
> > 
> > Signed-off-by: Katerina Koukiou <kkoukiou at redhat.com>
> > ---
> > docs/formatdomain.html.in | 10 +++++-----
> > 1 file changed, 5 insertions(+), 5 deletions(-)
> > 
> > diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> > index 7fa448acdc..61930e4907 100644
> > --- a/docs/formatdomain.html.in
> > +++ b/docs/formatdomain.html.in
> > @@ -831,11 +831,11 @@
> >       <dd>
> >         The optional <code>quota</code> element specifies the maximum allowed
> >         bandwidth(unit: microseconds). A domain with <code>quota</code> as any
> 
> There is a missing space before the parenthesis here, and it's copied
> multiple times for all the similar attributes. It's a good indicator
> that we should only write the repetititive text once, and collect the
> differences in a neat table, e.g.:
> 
> +---------------+----------------+---------+-------------------------+
> + quota element | period element | affects | since                   |
> +---------------+----------------+---------+-------------------------+
> + quota         | period         | vCPUs   | 0.9.4, LXC since 0.9.10 |
> + global_guota  | global_period  | all     | ...                     |
> +---------------+----------------+---------+-------------------------+
> 
> (But, of course, even this change is better than nothing)

Yes, this approach looks indeed cleaner. I 'll merge this patch with
Fabianos/Erics comment and I 'll keep moving to table format as a followup.

> 
> Jano
> 
> > -        negative value indicates that the domain has infinite bandwidth, which
> > -        means that it is not bandwidth controlled. The value should be in range
> > -        [1000, 18446744073709551] or less than 0. A quota with value 0 means no
> > -        value. You can use this feature to ensure that all vcpus run at the same
> > -        speed.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20180718/74853ecf/attachment-0001.sig>