[Bug 1726695] Re: Routes are not correctly documented in man pages

[Launchpad Bug Tracker]

This bug was fixed in the package nplan - 0.33

---------------
nplan (0.33) bionic; urgency=medium

  * replug: Do not unbind ath9kl_sdio. Thanks Oliver! (LP: #1741910)
  * doc: fix syntax for IPv6 example addresses. IPv6 needs to be escaped in
    YAML. (LP: #1735317)
  * debian/postinst: Write breadcrumbs on disk in /etc/network/interfaces to
    denote the migration to using netplan. (LP: #1744968)
  * bridge: implement port-priority support for the NM and networkd backends.
    (LP: #1735821)
  * doc: routes are not top-level but per-interface. (LP: #1726695)
  * Rework CLI parsing / code layout to better handle subcommands.

 -- Mathieu Trudel-Lapierre <cyphermox at ubuntu.com>  Tue, 23 Jan 2018
11:32:47 -0500

** Changed in: nplan (Ubuntu)
       Status: Fix Committed => Fix Released

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to nplan in Ubuntu.
https://bugs.launchpad.net/bugs/1726695

Title:
  Routes are not correctly documented in man pages

Status in netplan:
  Fix Committed
Status in nplan package in Ubuntu:
  Fix Released

Bug description:
  The only reference to routes in the man page in the complex example at
  the very bottom of the page.

  It's presented as being a top level element and doesn't specify
  interface.  netplan generate will not compile  this useage.

                  routes:
                   - to: 0.0.0.0/0
                     via: 11.0.0.1
                     metric: 3

  
  Examining the source code, under doc/example-config, there is a demonstration of the correct routes configuration which is under and interface definition.

  ethernets:
      # opaque ID for physical interfaces, only referred to by other stanzas
      id0:
        match:
          macaddress: 00:11:22:33:44:55
        wakeonlan: true
        dhcp4: true
        addresses:
          - 192.168.14.2/24
          - 2001:1::1/64
        gateway4: 192.168.14.1
        gateway6: 2001:1::2
        routes:
         - to: 11.22.0.0/16
           via: 192.168.14.3
           metric: 100
        nameservers:
          search: [foo.local, bar.local]
          addresses: [8.8.8.8]


  Please update the man page and fill out a complete list of options
  available for a route.

To manage notifications about this bug go to:
https://bugs.launchpad.net/netplan/+bug/1726695/+subscriptions