[libvirt] [PATCH] docs: Document <sndbuf/>
This element has been introduced in fe053dbea7, but isn't documented yet. After exactly 6 years I guess we can finally document it. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- docs/formatdomain.html.in | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 39f5a8823..30cb19626 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -4975,6 +4975,9 @@ qemu-kvm -net nic,model=? /dev/null <model type='virtio'/> <b><backend tap='/dev/net/tun' vhost='/dev/vhost-net'/></b> <driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'/> + <b><tune> + <sndbuf>1600</sndbuf> + </tune></b> </interface> </devices> ...</pre> @@ -4985,7 +4988,12 @@ qemu-kvm -net nic,model=? /dev/null device path (<code>/dev/vhost-net</code>) for devices with <code>virtio</code> model. The <code>tap</code> attribute overrides the tun/tap device path (default: <code>/dev/net/tun</code>) for network and bridge interfaces. This does not work - in session mode. + in session mode. <span class="since">Since 1.2.9</span> + </p> + <p> + For tap devices there is also <code>sndbuf</code> element which can + adjust the size of send buffer in the host. <span class="since">Since + 0.8.8</span> </p> <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5> -- 2.11.0
On Thu, Jan 12, 2017 at 12:49:19PM +0100, Michal Privoznik wrote:
This element has been introduced in fe053dbea7, but isn't documented yet. After exactly 6 years I guess we can finally document it.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- docs/formatdomain.html.in | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)
ACK, trivial docs, safe for freeze. Do we really want to say the version there? =D
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 39f5a8823..30cb19626 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -4975,6 +4975,9 @@ qemu-kvm -net nic,model=? /dev/null <model type='virtio'/> <b><backend tap='/dev/net/tun' vhost='/dev/vhost-net'/></b> <driver name='vhost' txmode='iothread' ioeventfd='on' event_idx='off' queues='5'/> + <b><tune> + <sndbuf>1600</sndbuf> + </tune></b> </interface> </devices> ...</pre> @@ -4985,7 +4988,12 @@ qemu-kvm -net nic,model=? /dev/null device path (<code>/dev/vhost-net</code>) for devices with <code>virtio</code> model. The <code>tap</code> attribute overrides the tun/tap device path (default: <code>/dev/net/tun</code>) for network and bridge interfaces. This does not work - in session mode. + in session mode. <span class="since">Since 1.2.9</span> + </p> + <p> + For tap devices there is also <code>sndbuf</code> element which can + adjust the size of send buffer in the host. <span class="since">Since + 0.8.8</span> </p> <h5><a name="elementsNICSTargetOverride">Overriding the target element</a></h5>
-- 2.11.0
-- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
On 01/12/2017 03:33 PM, Martin Kletzander wrote:
On Thu, Jan 12, 2017 at 12:49:19PM +0100, Michal Privoznik wrote:
This element has been introduced in fe053dbea7, but isn't documented yet. After exactly 6 years I guess we can finally document it.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- docs/formatdomain.html.in | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)
ACK, trivial docs, safe for freeze. Do we really want to say the version there? =D
Well, I think that everything should say the version it was introduced in. IMO by reading docs you should not only know how to enable the feature but also whether your software is new enough to support the feature in the first place. Another approach would be to have separate docs per each release. Then we can drop <since/> entirely. Pushed. With the version mentioned :-) Thanks. Michal
On Thu, Jan 12, 2017 at 04:18:58PM +0100, Michal Privoznik wrote:
On 01/12/2017 03:33 PM, Martin Kletzander wrote:
On Thu, Jan 12, 2017 at 12:49:19PM +0100, Michal Privoznik wrote:
This element has been introduced in fe053dbea7, but isn't documented yet. After exactly 6 years I guess we can finally document it.
Signed-off-by: Michal Privoznik <mprivozn@redhat.com> --- docs/formatdomain.html.in | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)
ACK, trivial docs, safe for freeze. Do we really want to say the version there? =D
Well, I think that everything should say the version it was introduced in. IMO by reading docs you should not only know how to enable the feature but also whether your software is new enough to support the feature in the first place. Another approach would be to have separate docs per each release. Then we can drop <since/> entirely.
It was rather fun play on the fact that we're adding documentation for something 107 releases after it was introduced, very specific to this one. Of course I agree with the version mentioning in other cases.
Pushed. With the version mentioned :-) Thanks.
Michal
participants (2)
-
Martin Kletzander -
Michal Privoznik