[libvirt] [PATCH] formatdomain.html.in: Correctly use <code/> in #elementQoS

Interestingly, we had <code>floor<code> ... </code>outbound</code> which results in much larger block of text to be written in code style that intended. --- docs/formatdomain.html.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7601aaa..d2cee67 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -3539,12 +3539,12 @@ qemu-kvm -net nic,model=? /dev/null forward type of route, nat, or no forward at all). Moreover, the virtual network the interface is connected to is required to have at least inbound QoS set (<code>average</code> at least). Moreover, with - <code>floor<code> attribute users don't need to specify + <code>floor</code> attribute users don't need to specify <code>average</code>. However, <code>peak</code> and <code>burst</code> attributes still require <code>average</code>. Currently, linux kernel doesn't allow ingress qdiscs to have any classes therefore <code>floor</code> can be applied only on <code>inbound</code> and not - </code>outbound</code>. <span class="since">Since 1.0.1</span> + <code>outbound</code>. <span class="since">Since 1.0.1</span> </p> <h5><a name="elementVlanTag">Setting VLAN tag (on supported network types only)</a></h5> -- 1.8.1.5

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

On 07/26/2013 11:46 AM, Michal Privoznik wrote:
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
ACK, Martin

On 07/26/2013 11:46 AM, Michal Privoznik wrote:
Interestingly, we had <code>floor<code> ... </code>outbound</code> which results in much larger block of text to be written in code style that intended. --- docs/formatdomain.html.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 7601aaa..d2cee67 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -3539,12 +3539,12 @@ qemu-kvm -net nic,model=? /dev/null forward type of route, nat, or no forward at all). Moreover, the virtual network the interface is connected to is required to have at least inbound QoS set (<code>average</code> at least). Moreover, with - <code>floor<code> attribute users don't need to specify + <code>floor</code> attribute users don't need to specify <code>average</code>. However, <code>peak</code> and <code>burst</code> attributes still require <code>average</code>. Currently, linux kernel doesn't allow ingress qdiscs to have any classes therefore <code>floor</code> can be applied only on <code>inbound</code> and not - </code>outbound</code>. <span class="since">Since 1.0.1</span> + <code>outbound</code>. <span class="since">Since 1.0.1</span> </p>
<h5><a name="elementVlanTag">Setting VLAN tag (on supported network types only)</a></h5>
ACK, trivial. Martin
participants (2)
-
Martin Kletzander
-
Michal Privoznik