[Bug 1756587] Re: mii-mon should have a consistent unit schema

[Mathieu Trudel-Lapierre]

The manpage is missing a doc update here, clearly.

We made sure the units were consistently milliseconds where appropriate
(some parameters are always seconds, no matter what backend is used)
late in the bionic cycle (LP: #1765833); the last of these updates
included a doc change, but it didn't change it by much.

Let's fix this in a SRU.


** Changed in: netplan
       Status: Triaged => In Progress

** Also affects: netplan.io (Ubuntu)
   Importance: Undecided
       Status: New

** Changed in: netplan.io (Ubuntu)
   Importance: Undecided => High

** Changed in: netplan.io (Ubuntu)
       Status: New => In Progress

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to netplan.io in Ubuntu.
Matching subscriptions: foundations-bugs
https://bugs.launchpad.net/bugs/1756587

Title:
  mii-mon should have a consistent unit schema

Status in netplan:
  In Progress
Status in netplan.io package in Ubuntu:
  In Progress

Bug description:
  [Impact]
  Documentation is confusing to users wishing to tune bond and bridge parameters. This potentially affects all users of netplan.

  
  [Test case]
  1) Update the netplan.io package.
  2) Run 'man netplan'
  3) Verify that the documentation under "parameters" for bridges and bonds is clear that time-based parameters are in milliseconds unless otherwise specified by the individual parameter:

  For example, in the bonds section:
   - learn-packet-interval is in seconds
   - mii-monitor-interval, up-delay, down-delay, arp-interval  are in milliseconds

  
  [Regression potential]
  Change is limited to the manpage; there is no risk of regression there, except for a garbled manpage or missing file. Any new bugs in netplan behavior found after this SRU that can't be reproduced with the immediately previous version should be investigated as potential toolchain / build issues introduced by the new build required for the SRU.

  ---

  The docs say "Using the NetworkManager renderer, parameter values for
  intervals should be expressed in milliseconds; for the systemd
  renderer, they should be in seconds unless otherwise specified."

  This however fails to encapsulate the description of the network in a
  form abstracted from the renderer. We should have a scheme which is
  clear, has one and only one explicit form, and works with all
  renderers.

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