summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCaleb Xavier Berger <caleb.x.berger@gmail.com>2020-08-13 09:52:55 -0400
committerGitHub <noreply@github.com>2020-08-13 09:52:55 -0400
commit46950cc404da411269d751953bfbcead90ee6806 (patch)
tree605ee9b831cf99da67f5e9357a9e657923fc6dcf /doc
parent6d74815af1591c5ccac6fd4d2a5cb95391e52fcb (diff)
downloadvyos-cloud-init-46950cc404da411269d751953bfbcead90ee6806.tar.gz
vyos-cloud-init-46950cc404da411269d751953bfbcead90ee6806.zip
Fix headers for device types in network v2 docs (#532)
Diffstat (limited to 'doc')
-rw-r--r--doc/rtd/topics/network-config-format-v2.rst10
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/rtd/topics/network-config-format-v2.rst b/doc/rtd/topics/network-config-format-v2.rst
index 7f857550..c93e29be 100644
--- a/doc/rtd/topics/network-config-format-v2.rst
+++ b/doc/rtd/topics/network-config-format-v2.rst
@@ -50,9 +50,8 @@ currently being defined.
There are two physically/structurally different classes of device definitions,
and the ID field has a different interpretation for each:
-Physical devices
-
-: (Examples: ethernet, wifi) These can dynamically come and go between
+Physical devices (Examples: ethernet, wifi):
+ These can dynamically come and go between
reboots and even during runtime (hotplugging). In the generic case, they
can be selected by ``match:`` rules on desired properties, such as
name/name pattern, MAC address, driver, or device paths. In general these
@@ -69,9 +68,8 @@ Physical devices
which is only being used for references from definitions of compound
devices in the config.
-Virtual devices
-
-: (Examples: veth, bridge, bond) These are fully under the control of the
+Virtual devices (Examples: veth, bridge, bond):
+ These are fully under the control of the
config file(s) and the network stack. I. e. these devices are being created
instead of matched. Thus ``match:`` and ``set-name:`` are not applicable for
these, and the ID field is the name of the created virtual device.