[Bug 1787495] Re: no explanation for the events in the networkd-dispatcher manpage

[Julian Andres Klode]

** Also affects: systemd (Ubuntu Cosmic)
   Importance: Undecided
       Status: New

** Also affects: networkd-dispatcher (Ubuntu Cosmic)
   Importance: Undecided
       Status: New

** Also affects: systemd (Ubuntu Bionic)
   Importance: Undecided
       Status: New

** Also affects: networkd-dispatcher (Ubuntu Bionic)
   Importance: Undecided
       Status: New

** Changed in: systemd (Ubuntu Cosmic)
       Status: New => Fix Released

** Changed in: networkd-dispatcher (Ubuntu Cosmic)
       Status: New => In Progress

** Changed in: networkd-dispatcher (Ubuntu Bionic)
       Status: New => In Progress

** Changed in: systemd (Ubuntu Bionic)
       Status: New => Triaged

** Description changed:

+ [Impact]
  networkd-dispatcher supports four hook directories:
  
  $ ls /usr/lib/networkd-dispatcher/
  dormant.d  no-carrier.d  off.d  routable.d
  $
  
  The manpage does not define what these hooks mean.  'routable' and 'no-
  carrier' are self-explanatory, but it's not at all clear what 'dormant'
  vs 'off' mean.  It's not at all clear what events one should expect to
  see as part of device bring-up.
  
  This needs to be better documented.
+ 
+ [Test case]
+ Check that it networkd-dispatcher(8) it's documented in networkctl(1), and that networkctl(1) documents it
+ 
+ [Regression potential]
+ If user updates networkd-dispatcher before systemd, they get the reference to networkctl(1) in networkd-dispatcher(8), but won't find any related text in there...

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

Title:
  no explanation for the events in the networkd-dispatcher manpage

Status in networkd-dispatcher package in Ubuntu:
  Fix Committed
Status in systemd package in Ubuntu:
  Fix Released
Status in networkd-dispatcher source package in Bionic:
  In Progress
Status in systemd source package in Bionic:
  Triaged
Status in networkd-dispatcher source package in Cosmic:
  In Progress
Status in systemd source package in Cosmic:
  Fix Released

Bug description:
  [Impact]
  networkd-dispatcher supports four hook directories:

  $ ls /usr/lib/networkd-dispatcher/
  dormant.d  no-carrier.d  off.d  routable.d
  $

  The manpage does not define what these hooks mean.  'routable' and
  'no-carrier' are self-explanatory, but it's not at all clear what
  'dormant' vs 'off' mean.  It's not at all clear what events one should
  expect to see as part of device bring-up.

  This needs to be better documented.

  [Test case]
  Check that it networkd-dispatcher(8) it's documented in networkctl(1), and that networkctl(1) documents it

  [Regression potential]
  If user updates networkd-dispatcher before systemd, they get the reference to networkctl(1) in networkd-dispatcher(8), but won't find any related text in there...

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/networkd-dispatcher/+bug/1787495/+subscriptions