summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2020-12-24 14:05:47 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2020-12-24 14:05:47 +0000
commitaab9231aeeec1f18b89163e06fe16c3718c2abba (patch)
treeb0df80a5b7e0eae9acbecd78c0b7fa35f9200518 /doc
parentf982dc64bfa4c6c42652f30af4d1389ca8fbc3e9 (diff)
downloadmdevd-aab9231aeeec1f18b89163e06fe16c3718c2abba.tar.xz
Prepare for 0.1.3.0; add -C option for autocoldplug
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html4
-rw-r--r--doc/mdevd.html13
-rw-r--r--doc/upgrade.html10
3 files changed, 24 insertions, 3 deletions
diff --git a/doc/index.html b/doc/index.html
index 594196b..0f03ac9 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -98,7 +98,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.9.3.0 or later. It's a build-time requirement. It's also a run-time
+2.10.0.0 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>
</ul>
@@ -114,7 +114,7 @@ library. </li>
<ul>
<li> The current released version of mdevd is
-<a href="mdevd-0.1.2.0.tar.gz">0.1.2.0</a>. </li>
+<a href="mdevd-0.1.3.0.tar.gz">0.1.3.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.html b/doc/mdevd.html
index 2ef2dfb..3412253 100644
--- a/doc/mdevd.html
+++ b/doc/mdevd.html
@@ -49,7 +49,7 @@ to running mdevd over mdev. </li>
<h2> Interface </h2>
<pre>
- mdevd [ -v <em>verbosity</em> ] [ -D <em>notif</em> ] [ -o <em>outputfd</em> ] [ -b <em>kbufsz</em> ] [ -f <em>conffile</em> ] [ -n ] [ -s <em>slashsys</em> ] [ -d <em>slashdev</em> ] [ -F <em>fwbase</em> ]
+ mdevd [ -v <em>verbosity</em> ] [ -D <em>notif</em> ] [ -o <em>outputfd</em> ] [ -b <em>kbufsz</em> ] [ -f <em>conffile</em> ] [ -n ] [ -s <em>slashsys</em> ] [ -d <em>slashdev</em> ] [ -F <em>fwbase</em> ] [ -C ]
</pre>
<ul>
@@ -124,6 +124,17 @@ are to be found in <em>slashdev</em>. Default is <tt>/dev</tt>.
<li> <tt>-F</tt>&nbsp;<em>fwbase</em>&nbsp;: assume the firmware files, if any,
are to be found in <em>fwbase</em>. Default is <tt>/lib/firmware</tt>.
<em>fwbase</em> must be an absolute path. </li>
+ <li> <tt>-C</tt>&nbsp;: after initialization (when mdevd is ready), invoke
+<a href="mdevd-coldplug.html">mdevd-coldplug</a>, so that a coldplug is
+automatically performed when mdevd starts. This option should only be used
+in situations where a drop-in replacement for <tt>mdev -d</tt> is needed, because
+it has the drawback of performing a coldplug every time mdevd is started &mdash;
+including when mdevd is killed and restarted. By default, mdevd does not perform
+a coldplug when it starts, and it is up to the administrator to properly organize
+their boot scripts to run <a href="mdevd-coldplug.html">mdevd-coldplug</a> once,
+at boot time, when mdevd is ready. The <tt>examples/s6-rc</tt> subdirectory of
+the mdevd package shows a way to do this with the
+<a href="//skarnet.org/softwre/s6-rc/">s6-rc</a> service manager. </li>
</ul>
<h2> Configuration file </h2>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 2725faf..7775575 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,16 @@
<h1> What has changed in mdevd </h1>
+<h2> in 0.1.3.0 </h2>
+
+<ul>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
+dependency bumped to 2.10.0.0. </li>
+ <li> A <tt>-C</tt> option has been added to
+<a href="mdevd.html">mdevd</a>. This triggers a coldplug when
+mdevd is ready, for faithful <tt>mdev -d</tt> emulation. </li>
+</ul>
+
<h2> in 0.1.2.0 </h2>
<ul>