[libvirt] [PATCH] formatdomain.html.in: Document implementation limitation of QoS

The outbound/@peak is ignored (since QoS was introduced). This is due to kernel limitation of know allowing ingress filters to have peak just average rate. However, we should document this limitation to not confuse users. --- docs/formatdomain.html.in | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index d2cee67..78e132e 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -3530,7 +3530,9 @@ qemu-kvm -net nic,model=? /dev/null <code>peak</code> speed. Accepted values for attributes are integer numbers. The units for <code>average</code> and <code>peak</code> attributes are kilobytes per second, and for the <code>burst</code> just kilobytes. - <span class="since">Since 0.9.4</span> The <code>inbound</code> can + Note the limitation of implementation: the <code>peak</code> attribute in + <code>outbound</code> element is ignored (as linux ingress filters don't + know it yet). <span class="since">Since 0.9.4</span> The <code>inbound</code> can optionally have <code>floor</code> attribute. This is there for guaranteeing minimal throughput for shaped interfaces. This, however, requires that all traffic goes through one point where QoS decisions can -- 1.8.1.5