netplan-developers team mailing list archive

[Joshua Powers <josh.powers@xxxxxxxxxxxxx>]

Joshua Powers has proposed merging ~powersj/netplan:shorten-comments into netplan:master.

Commit message:
Shorten code comments
    
The code comments are too long to properly show up on the web
version of the site. This shortens them down such that any future
sync between the man page docs and the website do not require
any additional changes.


Requested reviews:
  Developers of netplan (netplan-developers)

For more details, see:
https://code.launchpad.net/~powersj/netplan/+git/netplan/+merge/343221
-- 
Your team Developers of netplan is requested to review the proposed merge of ~powersj/netplan:shorten-comments into netplan:master.

diff --git a/doc/netplan.md b/doc/netplan.md
index 146ae01..27bf3db 100644
--- a/doc/netplan.md
+++ b/doc/netplan.md
@@ -185,7 +185,7 @@ Virtual devices
     requires setting ``addresses`` too. Gateway IPs must be in a form
     recognized by **``inet_pton``**(3).
 
-    Example for IPv4: ``gateway4: 172.16.0.1``  
+    Example for IPv4: ``gateway4: 172.16.0.1``
     Example for IPv6: ``gateway6: "2001:4::1"``
 
 ``nameservers`` (mapping)
@@ -638,29 +638,31 @@ This is a complex example which shows most available features:
           set-name: lom1
           dhcp6: true
         switchports:
-          # all cards on second PCI bus; unconfigured by themselves, will be added
-          # to br0 below (note: globbing is not supported by NetworkManager)
+          # all cards on second PCI bus unconfigured by
+          # themselves, will be added to br0 below
+          # note: globbing is not supported by NetworkManager
           match:
             name: enp2*
           mtu: 1280
       wifis:
         all-wlans:
-          # useful on a system where you know there is only ever going to be one device
+          # useful on a system where you know there is
+          # only ever going to be one device
           match: {}
           access-points:
             "Joe's home":
               # mode defaults to "infrastructure" (client)
               password: "s3kr1t"
-        # this creates an AP on wlp1s0 using hostapd; no match rules, thus ID is
-        # the interface name
+        # this creates an AP on wlp1s0 using hostapd
+        # no match rules, thus the ID is the interface name
         wlp1s0:
           access-points:
             "guest":
                mode: ap
                # no WPA config implies default of open
       bridges:
-        # the key name is the name for virtual (created) interfaces; no match: and
-        # set-name: allowed
+        # the key name is the name for virtual (created) interfaces
+        # no match: and set-name: allowed
         br0:
           # IDs of the components; switchports expands into multiple interfaces
           interfaces: [wlp1s0, switchports]