shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 17:34:18 +03:00
Code Releases Activity

docs: Convert 'formatnetwork' page to rst

Browse Source 
Additionally hyperlinks in other parts of the documentation are updated
to match.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Peter Krempa 2022-04-08 10:25:27 +02:00
parent 8b3d9314ae
commit 2a8946ca7e
6 changed files with 1151 additions and 1485 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/formatdomain.rst
View File

@ -5542,7 +5542,7 @@ Quality of service
This part of interface XML provides setting quality of service. Incoming and This part of interface XML provides setting quality of service. Incoming and
outgoing traffic can be shaped independently. The ``bandwidth`` element and its outgoing traffic can be shaped independently. The ``bandwidth`` element and its
child elements are described in the `QoS <formatnetwork.html#elementQoS>`__ child elements are described in the `QoS <formatnetwork.html#quality-of-service>`__
section of the Network XML. section of the Network XML.
:anchor:`<a id="elementVlanTag"/>` :anchor:`<a id="elementVlanTag"/>`
@ -5746,7 +5746,7 @@ address of the other end of a point-to-point network device :since:`(since
:since:`Since 1.2.12` route elements can also be added to define IP routes to :since:`Since 1.2.12` route elements can also be added to define IP routes to
add in the guest. The attributes of this element are described in the add in the guest. The attributes of this element are described in the
documentation for the ``route`` element in `network documentation for the ``route`` element in `network
definitions <formatnetwork.html#elementsStaticroute>`__. This is used by the LXC definitions <formatnetwork.html#static-routes>`__. This is used by the LXC
driver. driver.
:: ::

1479
docs/formatnetwork.html.in
View File

File diff suppressed because it is too large Load Diff

1144
docs/formatnetwork.rst Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/formatnetworkport.rst
View File

@ -78,7 +78,7 @@ The following elements are common to one or more of the plug types listed later
This part of the network port XML provides setting quality of service. This part of the network port XML provides setting quality of service.
Incoming and outgoing traffic can be shaped independently. The ``bandwidth`` Incoming and outgoing traffic can be shaped independently. The ``bandwidth``
element and its child elements are described in the element and its child elements are described in the
`QoS <formatnetwork.html#elementQoS>`__ section of the Network XML. In `QoS <formatnetwork.html#quality-of-service>`__ section of the Network XML. In
addition the ``classID`` attribute may exist to provide the ID of the traffic addition the ``classID`` attribute may exist to provide the ID of the traffic
shaping class that is active. shaping class that is active.
``rxfilters`` ``rxfilters``

5
docs/manpages/virsh.rst
View File

@ -2017,7 +2017,8 @@ inbound or outbound bandwidth. *average,peak,burst,floor* is the same as
in command *attach-interface*. Values for *average*, *peak* and *floor* in command *attach-interface*. Values for *average*, *peak* and *floor*
are expressed in kilobytes per second, while *burst* is expressed in kilobytes are expressed in kilobytes per second, while *burst* is expressed in kilobytes
in a single burst at *peak* speed as described in the Network XML in a single burst at *peak* speed as described in the Network XML
documentation at `https://libvirt.org/formatnetwork.html#elementQoS <https://libvirt.org/formatnetwork.html#elementQoS>`__. documentation at
`https://libvirt.org/formatnetwork.html#quality-of-service <https://libvirt.org/formatnetwork.html#quality-of-service>`__.
To clear inbound or outbound settings, use *--inbound* or *--outbound* To clear inbound or outbound settings, use *--inbound* or *--outbound*
respectfully with average value of zero. respectfully with average value of zero.
@ -4824,7 +4825,7 @@ specified. The other two *peak* and *burst* are optional, so
are expressed in kilobytes per second, while *burst* is expressed in are expressed in kilobytes per second, while *burst* is expressed in
kilobytes in a single burst at *peak* speed as described in the kilobytes in a single burst at *peak* speed as described in the
Network XML documentation at Network XML documentation at
`https://libvirt.org/formatnetwork.html#elementQoS <https://libvirt.org/formatnetwork.html#elementQoS>`__. `https://libvirt.org/formatnetwork.html#quality-of-service <https://libvirt.org/formatnetwork.html#quality-of-service>`__.
``--managed`` is usable only for *hostdev* type and tells libvirt ``--managed`` is usable only for *hostdev* type and tells libvirt
that the interface should be managed, which means detached and reattached that the interface should be managed, which means detached and reattached

2
docs/meson.build
View File

@ -18,7 +18,6 @@ docs_assets = [
] ]
docs_html_in_files = [ docs_html_in_files = [
'formatnetwork',
'formatnode', 'formatnode',
'index', 'index',
'remote', 'remote',
@ -72,6 +71,7 @@ docs_rst_files = [
'formatcheckpoint', 'formatcheckpoint',
'formatdomain', 'formatdomain',
'formatdomaincaps', 'formatdomaincaps',
'formatnetwork',
'formatnetworkport', 'formatnetworkport',
'formatnwfilter', 'formatnwfilter',
'formatsecret', 'formatsecret',