Invalid YAML in docs
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Netplan |
Fix Released
|
High
|
Mathieu Trudel-Lapierre | ||
nplan (Ubuntu) |
Fix Released
|
High
|
Mathieu Trudel-Lapierre | ||
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.
---
In the documentation there are examples of YAML definitions that are not valid YAML syntax. Take for example:
addresses: [192.168.14.2/24, 2001:1::1/64]
This will error with:
(<unknown>): found unexpected ':' while scanning a plain scalar at line 1 column 31
This is because the IPv6 address has a ':' and it is not escaped. Putting quotes around the IPv6 address or avoiding the one line list format would be best.
This occurs again in the nameservers example with:
addresses: [8.8.8.8, FEDC::1]
description: | updated |
Changed in netplan: | |
status: | New → Triaged |
importance: | Undecided → High |
assignee: | nobody → Mathieu Trudel-Lapierre (cyphermox) |
Changed in nplan (Ubuntu): | |
status: | New → Triaged |
importance: | Undecided → High |
assignee: | nobody → Mathieu Trudel-Lapierre (cyphermox) |
Changed in netplan: | |
status: | Triaged → Fix Committed |
description: | updated |
Changed in netplan: | |
status: | Fix Committed → Fix Released |
Landed various fixes for doc syntax:
https:/ /git.launchpad. net/netplan/ commit/ ?id=70a71546c6c c69c8279dcebfdb aa28f1b8e901da /git.launchpad. net/netplan/ commit/ ?id=e355931ebaa d609b9ed6a26e80 972fd3afa0e7a7
https:/
nplan 0.33 has been uploaded to bionic-proposed, but is currently blocked on a juju-core SRU to xenial.