]> git.ipfire.org Git - thirdparty/qemu.git/commit
qemu-doc: Rework the network options chapter to make "-net" less prominent
authorThomas Huth <thuth@redhat.com>
Mon, 12 Mar 2018 12:20:50 +0000 (13:20 +0100)
committerJason Wang <jasowang@redhat.com>
Fri, 30 Mar 2018 03:44:11 +0000 (11:44 +0800)
commitabbbb0350d780e24d2f6a0cf8fc3191badb0329a
tree9103ed6fd04a11b70b37dad21b4b154c868bd533
parent47d3b60858d90ac8a0cc3a72af7f95c96781125a
qemu-doc: Rework the network options chapter to make "-net" less prominent

"-net" is clearly a legacy option. Yet we still use it in almost all
examples in the qemu documentation, and many other spots in the network
chapter. We should make it less prominent that users are not lured into
using it so often anymore. So instead of starting the network chapter with
"-net nic" and documenting "-net <backend>" below "-netdev <backend>"
everywhere, all the "-net" related documentation is now moved to the end
of the chapter. The new "-nic" option is moved to the beginning of the
chapter instead, with a new example that should demonstrate how "-nic"
can be used to shortcut "-device" with "-netdev". The examples in this
chapter are changed to use the "-device" and "-netdev" options or
"-nic" instead of "-net nic -net <backend>".

While we're at it, also remove a legacy remark about very old Linux
distributions. Also remove the "[...]" from the examples in this chapter
since we are not using this ellipsis in any other examples in our docu-
mentation.

Signed-off-by: Thomas Huth <thuth@redhat.com>
Signed-off-by: Jason Wang <jasowang@redhat.com>
qemu-options.hx