summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2017-10-26 14:03:33 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2017-10-26 14:03:33 +0000
commitbc81629c44b0083efa18ef11b653890a3c283645 (patch)
treee71c8a674688d9c50a265a1b79b65b6959ba8631 /doc
parentafba22c15cf2894eade816c87574ba02bc85c1da (diff)
downloads6-linux-utils-bc81629c44b0083efa18ef11b653890a3c283645.tar.gz
s6-linux-utils-bc81629c44b0083efa18ef11b653890a3c283645.tar.xz
s6-linux-utils-bc81629c44b0083efa18ef11b653890a3c283645.zip
Deprecate s6-uevent-*, prepare for 2.4.0.2
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html10
-rw-r--r--doc/s6-uevent-listener.html16
-rw-r--r--doc/s6-uevent-spawner.html9
-rw-r--r--doc/upgrade.html6
4 files changed, 32 insertions, 9 deletions
diff --git a/doc/index.html b/doc/index.html
index ab1a855..150bb22 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -34,7 +34,7 @@
 The Linux kernel must be 3.5 or later. </li>
  <li> GNU make, version 3.81 or later </li>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.6.0.0 or later. It's a build-time requirement. It's also a run-time
+2.6.0.2 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>
@@ -50,7 +50,7 @@ library. </li>
 
 <ul>
  <li> The current released version of s6-linux-utils is
-<a href="s6-linux-utils-2.4.0.1.tar.gz">2.4.0.1</a>. </li>
+<a href="s6-linux-utils-2.4.0.2.tar.gz">2.4.0.2</a>. </li>
  <li> Alternatively, you can checkout a copy of the
 <a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-linux-utils/">s6-linux-utils
 git repository</a>:
@@ -89,8 +89,8 @@ the previous versions of s6-linux-utils and the current one. </li>
 <ul>
 <li><a href="s6-chroot.html">The <tt>s6-chroot</tt> program</a></li>
 <li><a href="s6-devd.html">The <tt>s6-devd</tt> program</a></li>
-<li><a href="s6-uevent-listener.html">The <tt>s6-uevent-listener</tt> program</a></li>
-<li><a href="s6-uevent-spawner.html">The <tt>s6-uevent-spawner</tt> program</a></li>
+<li><a href="s6-uevent-listener.html">The <tt>s6-uevent-listener</tt> program</a> <strong>(deprecated)</strong></li>
+<li><a href="s6-uevent-spawner.html">The <tt>s6-uevent-spawner</tt> program</a> <strong>(deprecated)</strong></li>
 <li><a href="s6-fillurandompool.html">The <tt>s6-fillurandompool</tt> program</a></li>
 <li><a href="s6-freeramdisk.html">The <tt>s6-freeramdisk</tt> program</a></li>
 <li><a href="s6-hostname.html">The <tt>s6-hostname</tt> program</a></li>
@@ -121,6 +121,8 @@ instance:
 <ul>
  <li> <a href="http://busybox.net/">BusyBox</a> </li>
  <li> <a href="http://landley.net/code/toybox/">toybox</a> </li>
+ <li> <a href="https://core.suckless.org/sbase">sbase</a> and
+<a href="https://core.suckless.org/ubase">ubase</a> </li>
 </ul>
 
 <p>
diff --git a/doc/s6-uevent-listener.html b/doc/s6-uevent-listener.html
index 73bad1d..cd60639 100644
--- a/doc/s6-uevent-listener.html
+++ b/doc/s6-uevent-listener.html
@@ -5,7 +5,7 @@
     <meta http-equiv="Content-Language" content="en" />
     <title>s6-linux-utils: the s6-uevent-listener program</title>
     <meta name="Description" content="s6-linux-utils: the s6-uevent-listener program" />
-    <meta name="Keywords" content="s6 linux administration root utilities devd mdev udev s6-uevent-listener uevent" />
+    <meta name="Keywords" content="s6 linux administration root utilities devd mdev mdevd udev s6-uevent-listener uevent" />
     <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
   </head>
 <body>
@@ -24,6 +24,14 @@
 its standard output, using a simple format.
 </p>
 
+<p>
+<strong>This program is deprecated</strong>, and will disappear in a
+near future version of s6-linux-utils. It has been replaced with the
+<a href="//skarnet.org/software/mdevd/mdevd-netlink.html">mdevd-netlink</a>
+program, from the <a href="//skarnet.org/software/mdevd/">mdevd</a>
+package.
+</p>
+
 <h2> Interface </h2>
 
 <pre>
@@ -38,7 +46,7 @@ null characters, so a terminal will not display them correctly. To
 properly use s6-uevent-listener, it should be piped into a handler
 program such as
 <a href="s6-uevent-spawner.html">s6-uevent-spawner</a>.
-<!-- or <a href="mdevd.html">mdevd</a>. --> </li>
+or <a href="//skarnet.org/software/mdevd/mdevd.html">mdevd</a>. </li>
  <li> s6-uevent-listener is a long-lived program.
 When it receives a SIGTERM, it stops listening; it will
 exit as soon as it has flushed its event queue to stdout. </li>
@@ -93,12 +101,12 @@ only program handling uevents, which means that
  <li> Examples of valid uses of s6-uevent-listener:
   <ul>
    <li> <tt>s6-uevent-listener | s6-uevent-spawner mdev</tt> </li>
-<!--   <li> <tt>s6-uevent-listener | mdevd</tt> </li> -->
+   <li> <tt>s6-uevent-listener | mdevd</tt> </li>
    <li> Those examples can be made safer by using a supervision system:
 under <a href="//skarnet.org/software/s6/">s6</a> or
 <a href="//skarnet.org/software/s6-rc/">s6-rc</a>, write a service
 pipeline where <tt>s6-uevent-listener</tt> is a producer and
-<tt>s6-uevent-spawner mdev</tt> <!-- or <tt>mdevd</tt> --> is a consumer. This
+<tt>s6-uevent-spawner mdev</tt> or <tt>mdevd</tt> is a consumer. This
 setup has the advantage, among others, that you can restart the netlink
 listener and the event handler separately. </li>
   </ul>
diff --git a/doc/s6-uevent-spawner.html b/doc/s6-uevent-spawner.html
index f7a9d7b..6f2ab87 100644
--- a/doc/s6-uevent-spawner.html
+++ b/doc/s6-uevent-spawner.html
@@ -5,7 +5,7 @@
     <meta http-equiv="Content-Language" content="en" />
     <title>s6-linux-utils: the s6-uevent-spawner program</title>
     <meta name="Description" content="s6-linux-utils: the s6-uevent-spawner program" />
-    <meta name="Keywords" content="s6 linux administration root utilities devd mdev udev hotplug" />
+    <meta name="Keywords" content="s6 linux administration root utilities devd mdev mdevd udev hotplug" />
     <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
   </head>
 <body>
@@ -29,6 +29,13 @@ similarly to what the hotplug interface does.
 <a href="s6-uevent-listener.html">s6-uevent-listener</a>.
 </p>
 
+<p>
+<strong>This program is deprecated</strong>, and will disappear in a
+future version of s6-linux-utils. The
+<a href="//skarnet.org/software/mdevd/">mdevd</a> package makes it
+obsolete.
+</p>
+
 <h2> Interface </h2>
 
 <pre>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 9ff53c3..7899dac 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,12 @@
 
 <h1> What has changed in s6-linux-utils </h1>
 
+<h2> in 2.4.0.2 </h2>
+
+<ul>
+ <li> skalibs dependency bumped to 2.6.0.2. </li>
+</ul>
+
 <h2> in 2.4.0.1 </h2>
 
 <ul>