• J
    bandwidth: Adjust documentation · 7eb37a0d
    John Ferlan 提交于
    Recent autotest/virt-test testing on f20 discovered an anomaly in how
    the bandwidth options are documented and used. This was discovered due
    to a bug fix in the /sbin/tc utility found in iproute-3.11.0.1 (on f20)
    in which overflow was actually caught and returned as an error. The fix
    was first introduced in iproute-3.10 (search on iproute2 commit 'a303853e').
    
    The autotest/virt-test test for virsh domiftune was attempting to send
    the largest unsigned integer value (4294967295) for maximum value
    testing. The libvirt xml implementation was designed to manage values
    in kilobytes thus when this value was passed to /sbin/tc, it (now)
    properly rejected the 4294967295kbps value.
    
    Investigation of the problem discovered that formatdomain.html.in and
    formatnetwork.html.in described the elements and property types slightly
    differently, although they use the same code - virNetDevBandwidthParseRate()
    (shared by portgroups, domains, and networks xml parsers). Rather than
    have the descriptions in two places, this patch will combine and reword
    the description under formatnetwork.html.in and have formatdomain.html.in
    link to that description.
    
    This documentation faux pas was continued into the virsh man page where
    the bandwidth description for both 'attach-interface' and 'domiftune'
    did not indicate the format of each value, thus leading to the test using
    largest unsigned integer value assuming "bps" rather than "kbps", which
    ultimately was wrong.
    7eb37a0d
virsh.pod 144.9 KB