From d7a4a9b2ffe134eaf33c1965ab29a0fae416e166 Mon Sep 17 00:00:00 2001
From: Michal Privoznik <mprivozn@redhat.com>
Date: Fri, 26 Jul 2013 11:42:53 +0200
Subject: [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 d2cee678c8..78e132ea7f 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
-- 
2.39.5