Routes are not correctly documented in man pages
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Netplan |
Fix Released
|
High
|
Unassigned | ||
nplan (Ubuntu) |
Fix Released
|
High
|
Unassigned | ||
Xenial |
Fix Released
|
Undecided
|
Unassigned | ||
Artful |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
[Impact]
Netplan users referring to documentation to know how to write configurations.
[Test case]
1) check 'man netplan'
[Regression potential]
None, this change is limited to correcting incorrect documentation.
---
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.
- to: 0.0.0.0/0
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.
Changed in netplan: | |
status: | New → In Progress |
Changed in nplan (Ubuntu): | |
status: | New → In Progress |
importance: | Undecided → High |
Changed in netplan: | |
importance: | Undecided → High |
Changed in nplan (Ubuntu): | |
status: | In Progress → Fix Committed |
Changed in netplan: | |
status: | In Progress → Fix Committed |
description: | updated |
Changed in netplan: | |
status: | Fix Committed → Fix Released |
Refer to http:// manpages. ubuntu. com/manpages/ artful/ man5/netplan. 5.html