]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man/network: clarify SR-IOV section description and usage
authorTim Small <tim@seoss.co.uk>
Sun, 27 Apr 2025 11:47:53 +0000 (12:47 +0100)
committerYu Watanabe <watanabe.yu+github@gmail.com>
Wed, 30 Apr 2025 06:47:19 +0000 (15:47 +0900)
Document effect of the SR-IOV section in .link vs .network files and
restructure the SR-IOV section introduction for clarity.

man/systemd.link.xml

index 217352f979709a3832990c72d97feff477db9353..86507d3e3ab206d4bdeb494242660bd850118158 100644 (file)
 
   <refsect1 id='sr-iov'>
     <title>[SR-IOV] Section Options</title>
-    <para>The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to
-    configure several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource
-    into virtual PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV
-    improves north-south network performance (that is, traffic with endpoints outside the host machine)
-    by allowing traffic to bypass the host machine’s network stack.</para>
+    <para>SR-IOV provides the ability to partition a single physical PCI resource into virtual PCI
+    functions which can then be e.g. injected into a VM. In the case of network VFs, SR-IOV reduces
+    latency and CPU utilisation for north-south network traffic (that is, traffic with endpoints
+    outside the host machine), by allowing traffic to bypass the host machine’s network stack.
+    </para>
+
+    <para>The presence of an [SR-IOV] section in a .link file will cause the creation and
+    configuration of the specified virtual function. Within a .network file, the specified virtual
+    function will be configured, but must already exist. Specify several [SR-IOV] sections to
+    configure several SR-IOVs.</para>
+
+    <para>The [SR-IOV] section accepts the following keys.</para>
 
     <variablelist class='network-directives'>
       <varlistentry>