From 8ad0f7f39526ee0d8f52f44f5434dfd518f8897a Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Sun, 24 Jul 2022 00:28:32 +0000
Subject:  Add "settle" functionality to mdevd-colplug

- Still untested.
- Also prepare for 0.1.6.0.
- Includes a refactor of several functions in mdevd, moved
into an internal libmdevd that is also used by mdevd-coldplug.

Signed-off-by: Laurent Bercot <ska@appnovation.com>
---
 doc/index.html          |  6 +++---
 doc/mdevd-coldplug.html | 17 ++++++++++++++++-
 doc/upgrade.html        | 10 +++++++++-
 3 files changed, 28 insertions(+), 5 deletions(-)

(limited to 'doc')

diff --git a/doc/index.html b/doc/index.html
index e51e85c..c6261c4 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -99,7 +99,7 @@ and does not pull in any unnecessary code. </li>
 The Linux kernel must be 2.6.10 or later. </li>
  <li> GNU make, version 3.81 or later </li>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.12.0.0 or later. It's a build-time requirement. It's also a run-time
+2.12.0.1 or later. It's a build-time requirement. It's also a run-time
 requirement if you link against the shared version of the skalibs
 library. </li>
  <li> Optionally: <a href="//skarnet.org/software/execline/">nsss</a>
@@ -108,7 +108,7 @@ you use the <tt>--enable-nsss</tt> option to configure; but you would
 only do that if you're replacing nsswitch on your whole system, and most
 people are not. </li>
  <li> Optionally: <a href="//skarnet.org/software/execline/">execline</a>
-version 2.9.0.0 or later. It's a only a run-time requirement, and only
+version 2.9.0.1 or later. It's a only a run-time requirement, and only
 if your <tt>mdev.conf</tt> file contains <tt>+</tt>, <tt>-</tt> or
 <tt>&amp;</tt> command directives. </li>
 </ul>
@@ -124,7 +124,7 @@ if your <tt>mdev.conf</tt> file contains <tt>+</tt>, <tt>-</tt> or
 
 <ul>
  <li> The current released version of mdevd is
-<a href="mdevd-0.1.5.2.tar.gz">0.1.5.2</a>. </li>
+<a href="mdevd-0.1.6.0.tar.gz">0.1.6.0</a>. </li>
  <li> Alternatively, you can checkout a copy of the
 <a href="//git.skarnet.org/cgi-bin/cgit.cgi/mdevd/">mdevd
 git repository</a>:
diff --git a/doc/mdevd-coldplug.html b/doc/mdevd-coldplug.html
index 027c849..36654eb 100644
--- a/doc/mdevd-coldplug.html
+++ b/doc/mdevd-coldplug.html
@@ -28,7 +28,7 @@ for all these devices.
 <h2> Interface </h2>
 
 <pre>
-     mdevd-coldplug [ -s <em>slashsys</em> ]
+     mdevd-coldplug [ -v <em>verbosity</em> ] [ -s <em>slashsys</em> ] [ -O <em>nlgroup</em> ] [ -b <em>kbufsize</em> ]
 </pre>
 
 <ul>
@@ -43,8 +43,23 @@ at this point, it will pick up the series of events. </li>
 <h2> Options </h2>
 
 <ul>
+ <li> <tt>-v</tt>&nbsp;<em>verbosity</em>&nbsp;: be more or less verbose.
+Default verbosity is 1. 0 will only print fatal error messages, 3 or more
+is seriously verbose debugging. </li>
  <li> <tt>-s</tt>&nbsp;<em>slashsys</em>&nbsp;: assume the sysfs
 pseudo-filesystem is mounted on <em>slashsys</em>. Default is <tt>/sys</tt>. </li>
+ <li> <tt>-O</tt>&nbsp;<em>nlgroup</em>&nbsp;: synchronous coldplug.
+<tt>mdevd-coldplug</tt> will not exit until the last uevent it triggers
+has been handled by <a href="mdevd.html">mdevd</a>. <em>nlgroup</em>
+needs to be a netlink group that <a href="mdevd.html">mdevd</a> is
+rebroadcasting handled events to. Note that this option can only work
+if <a href="mdevd.html">mdevd</a> is running with a similar <tt>-O</tt>
+option with a compatible value; else, <tt>mdevd-coldplug</tt> will wait
+forever. </li>
+ <li> <tt>-b</tt>&nbsp;<em>kbufsz</em>&nbsp;: try and reserve a kernel buffer of
+<em>kbufsz</em> bytes for the netlink queue. The default is 500 kB;
+if you're getting "No buffer space available" errors, try increasing this number.
+This option is only meaningful when paired with the <tt>-O</tt> option. </li>
 </ul>
 
 <h2> Exit codes </h2>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 5ae8dd3..28485ee 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,15 @@
 
 <h1> What has changed in mdevd </h1>
 
+<h2> in 0.1.6.0 </h2>
+
+<ul>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
+dependency bumped to 2.12.0.1. </li>
+ <li> <a href="//skarnet.org/software/execline/">execline</a>
+optional dependency bumped to 2.9.0.1. </li>
+</ul>
+
 <h2> in 0.1.5.2 </h2>
 
 <ul>
@@ -27,7 +36,6 @@ dependency bumped to 2.12.0.0. </li>
 optional dependency bumped to 2.9.0.0. </li>
 </ul>
 
-
 <h2> in 0.1.5.1 </h2>
 
 <ul>
-- 
cgit 1.4.1