prefix ethtool attributes with "link-" to be compatible with

native ifupdown + documentation fixes

Ticket: CM-3000
Reviewed By: trivial + doc related
Testing Done: Ran precommit

docs/examples/interfaces

@@ -19,9 +19,9 @@ iface swp30
     address 2000:1000:1000:1000:3::5/128
     mtu 1600
     alias "test network"
-    duplex full
+    link-duplex full
-    autoneg on
+    link-speed 1000
-    speed 1000
+    link-autoneg off
 
 # bond interface
 auto bond3

man.rst/ifquery.8.rst

@@ -134,6 +134,12 @@ EXAMPLES
 
         (The above command only works on a system with dot installed)
 
+KNOWN_ISSUES
+============
+    **ifquery --check** is currently experimental
+
+    **ifquery --check** cannot validate usercommands given under pre-up, post-up etc
+    There is currently no support to check/validate ethtool iface attributes
 
 SEE ALSO
 ========

man.rst/ifreload.8.rst

@@ -6,7 +6,7 @@ ifreload
 reload network interface configuration
 --------------------------------------
 
-:Author: roopa@cumulusnetworks.com
+:Author: Roopa Prabhu <roopa@cumulusnetworks.com>
 :Date:   2014-02-05
 :Copyright: Copyright 2014 Cumulus Networks, Inc.  All rights reserved.
 :Version: 0.1
@@ -20,11 +20,11 @@ DESCRIPTION
 ===========
     reloads network **interfaces(5)** file **/etc/network/interfaces**.
 
-    runs ifdown on interfaces that changed in the interfaces file and
+    Runs **ifdown** on interfaces that changed in the interfaces file and
-    subsequently runs ifup on all interfaces.
+    subsequently runs **ifup** on all interfaces.
 
-    ifreload is equivalent to **ifdown -a** followed by **ifup -a**
+    **ifreload** is equivalent to **ifdown -a** followed by **ifup -a**
-    but it skips ifdown for interfaces that did not change in the config
+    but it skips **ifdown** for interfaces that did not change in the config
     file.
 
 

man.rst/ifup.8.rst

@@ -49,10 +49,13 @@ DESCRIPTION
 
     **ifup** and **ifdown** understands interface dependency order.
 
-    For logical devices like vlans, bridges, bonds **ifup** creates the
+    For logical interfaces like vlans, bridges, bonds, **ifup** creates the
-    interface and **ifdown** deletes the interface. Use **--no-scripts**
+    interface and **ifdown** deletes the interface. Use **--admin-state**
     option if you only want to administratively bring the interface up/down.
 
+    When **ifup** and **ifdown** are used with interfaces on command line,
+    they must be have a **iface** section in the **interfaces(5)** file.
+
 OPTIONS
 =======
     positional arguments:
@@ -83,7 +86,7 @@ OPTIONS
 
     -f, --force           force run all operations
 
-    -n, --no-act          print out what would happen,but don't do it
+    -n, --no-act          print out what would happen, but don't do it
 
     -p, --print-dependency {list,dot}
                           print iface dependency in list or dot format
@@ -143,11 +146,11 @@ EXAMPLES
 
         **ifdown -a -f**
 
-    # ifdown and ifup on all interfaces using service command/init script
+    # run ifdown and ifup on all interfaces using service command/init script
 
         **service networking restart**
 
-    # ifup on all interfaces using service command/init script
+    # run ifup on all interfaces using service command/init script
 
         **service networking start**
 
@@ -155,7 +158,7 @@ EXAMPLES
 
         **service networking stop**
 
-    # Also see **ifreload(8)**
+    # To run ifup/ifdown on only interfaces that changed see **ifreload(8)**
 
 SEE ALSO
 ========

man.rst/interfaces.5.rst

@@ -6,7 +6,7 @@ interfaces
 network interface configuration for ifupdown
 --------------------------------------------
 
-:Author: roopa@cumulusnetworks.com
+:Author: Roopa Prabhu <roopa@cumulusnetworks.com>
 :Date:   2014-02-05
 :Copyright: Copyright 2014 Cumulus Networks, Inc.  All rights reserved.
 :Version: 0.1
@@ -35,12 +35,10 @@ DESCRIPTION
 
         source /etc/network/interfaces.d/bridges
 
-        iface eth0-home inet static
+        iface eth0 inet static
             address 192.168.1.1/24
             up flush-mail
 
-        iface eth0-work inet dhcp
-    
         iface eth1 inet dhcp
 
     Lines beginning with the word "auto" are used to identify the physical
@@ -58,10 +56,10 @@ DESCRIPTION
     Lines beginning with "source" are used to include  stanzas  from  other
     files, so configuration can be split into many files. The word "source"
     is followed by the path of file to be sourced. Shell wildcards  can  be
-    used.  (See wordexp(3) for details.). Currently only supports absolute
+    used. Currently only supports absolute
     path names.
 
-    ifup is normally given a physical interface name as its first non-option
+    iface is normally given a interface name as its first non-option
     argument. 
 
     The interface name is followed by the name of the address family that the
@@ -70,18 +68,32 @@ DESCRIPTION
     interface.
 
     ifupdown supports iface stanzas without a family or a method. This enables
-    using the same stanza for inet and inet6 family addresses.
+    using the same stanza for inet and inet6 family addresses. And the method
+    defaults to "static"
 
-    Interface options can be given on subsequent lines in the iface stanza.
+    Additional interface options/attributes can be given on subsequent lines
-    These options come from addon modules. see ifupdown-addons-interfaces(5) for
+    in the iface stanza. These options come from addon modules. see
-    these options.
+    **ifupdown-addons-interfaces(5)** for these options.
+
+    example bridge interface with additional attributes listed in the
+    **ifupdown-addons-interfaces(5)** man page::
+
+        auto br0
+        iface br0
+            address 12.0.0.4/24
+            address 2000:1000:1000:1000:3::5/128
+            bridge-ports swp1 swp2 swp3
+            bridge-stp on
 
     ifupdown supports python-mako style templates in the interfaces file.
     See examples section for details.
 
+    See **/usr/share/doc/python-ifupdown2/examples/** for **interfaces(5)**
+    file examples and interfaces file generation scripts.
+
 METHODS
 =======
-    Both inet and inet6 address family interfaces can use the following
+    Both **inet** and **inet6** address family interfaces can use the following
     methods (However they are not required):
 
     The loopback Method
@@ -96,7 +108,7 @@ METHODS
 
 BUILTIN INTERFACES
 ==================
-    iface sections for some interfaces like physical interfaces or vlan
+    **iface** sections for some interfaces like physical interfaces or vlan
     interfaces in dot notation (like eth1.100) are understood by ifupdown.
     These interfaces do not need an entry in the interfaces file if
     they are dependents of other interfaces and dont need any specific

pkg/ifupdownmain.py

@@ -483,7 +483,7 @@ class ifupdownMain(ifupdownBase):
 
                     validrange = attrvaldict.get('validrange')
                     if validrange:
-                        print('%svalidrange: %d-%d'
+                        print('%svalidrange: %s-%s'
                               %(indent + '  ', validrange[0], validrange[1]))
 
                     validvals = attrvaldict.get('validvals')