'gratuitious-arp' may be a spelling error

Bug #1756701 reported by Mark Shuttleworth on 2018-03-18
34
This bug affects 4 people
Affects Status Importance Assigned to Milestone
netplan
Medium
Unassigned
netplan.io (Ubuntu)
Undecided
Unassigned
Bionic
Undecided
Unassigned

Bug Description

[Impact]
Netplan documentation

[Test case]
1) Run 'man netplan'
2) Validate that the documentation contains a correctly spelled parameter "gratuitous-arp".

[Regression potential]
This is a documentation-only fix. Watch out for documentation that fails to render correctly, or behavior that doesn't match what is documented.

---

I think this should be spelled 'gratuitous-arp'

Steve Langasek (vorlon) wrote :

appears to be a documentation-only bug

Changed in netplan:
status: New → Triaged
importance: Undecided → Medium
John A Meinel (jameinel) wrote :

Note also that it has an effect for network manager:
https://github.com/CanonicalLtd/netplan/blob/7afef6af053794a400d96f89a81c938c08420783/src/networkd.c#L191

but doesn't seem to matter for nm:
https://github.com/CanonicalLtd/netplan/blob/7afef6af053794a400d96f89a81c938c08420783/src/nm.c#L189

So it may be the that
a) Network Manager has the same typo
b) We've only tested on NM so didn't notice the spelling was wrong.

Daniel Axtens (daxtens) wrote :

For networkd, this misspelling causes the value to have no effect - regardless of the setting, I only see 1 gratuitous ARP in active-backup mode.

It also causes the following message to be printed to syslog:

Jul 20 09:27:48 netplan systemd-networkd[1082]: /run/systemd/network/10-netplan-bond0.netdev:9: Unknown lvalue 'GratuitiousARP' in section 'Bond'

Changing the networkd code to spit out the correct spelling causes the correct behaviour.

The NM parameter is num_grat_arp, which is not affected by the broader misspelling. However, NM is affected by a different bug which fixes the number of gratuitous arps to 1. This has been fixed upstream but not backported yet: https://github.com/NetworkManager/NetworkManager/commit/42b0bef33c77a0921590b2697f077e8ea7805166
The workaround is trivial so I have just included it in my patch.

I have put this all in a pull request: https://github.com/CanonicalLtd/netplan/pull/38

Regards,
Daniel

Daniel Axtens (daxtens) on 2018-07-22
Changed in netplan:
status: Triaged → In Progress
assignee: nobody → Daniel Axtens (daxtens)
Daniel Axtens (daxtens) wrote :

This has been merged and should be in the next release.

Changed in netplan:
status: In Progress → Fix Committed
John A Meinel (jameinel) wrote :

Do you support both spellings, or does config that was using the wrong
spelling need to be updated?
John
=:->

On Fri, Aug 31, 2018 at 11:40 AM, Daniel Axtens <<email address hidden>
> wrote:

> This has been merged and should be in the next release.
>
> ** Changed in: netplan
> Status: In Progress => Fix Committed
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1756701
>
> Title:
> 'gratuitious-arp' may be a spelling error
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/netplan/+bug/1756701/+subscriptions
>

Daniel Axtens (daxtens) wrote :

Both spellings are supported.

Regards,
Daniel

description: updated
Changed in netplan:
assignee: Daniel Axtens (daxtens) → nobody
status: Fix Committed → Fix Released
Changed in netplan.io (Ubuntu):
status: New → Fix Released
Daniel Axtens (daxtens) wrote :

Hi Matt,

I don't think this is documentation-only: it was rendered incorrectly out to networkd - see my comment #4.

Regards,
Daniel

Hello Mark, or anyone else affected,

Accepted netplan.io into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/netplan.io/0.40~18.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Changed in netplan.io (Ubuntu Bionic):
status: New → Fix Committed
tags: added: verification-needed verification-needed-bionic
Łukasz Zemczak (sil2100) wrote :

Hello Mark, or anyone else affected,

Accepted netplan.io into bionic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/netplan.io/0.40.1~18.04.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested and change the tag from verification-needed-bionic to verification-done-bionic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-bionic. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

root@harmless-perch:~# dpkg -l netplan.io | grep ii
ii netplan.io 0.40.1~18.04.1 amd64 YAML network configuration abstraction for various backends

I have verified that the manpage now correctly reads "gratuitous", and includes a note that the previous misspelling "gratuitious" in also accepted by netplan.

Marking verification-done.

tags: added: verification-done-bionic
removed: verification-needed verification-needed-bionic
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers