summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2015-03-09 18:17:00 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2015-03-09 18:17:00 +0000
commit3aeeaac1fee0a985416879fd88ed89a26da989d6 (patch)
tree670680f6da8dcf4e4cddb545b7307b80420d40ac
parent1acdafbf731ac703fdb24916c4be6424405170b7 (diff)
downloads6-linux-utils-3aeeaac1fee0a985416879fd88ed89a26da989d6.tar.xz
Doc fixes
-rw-r--r--doc/s6-devd.html7
-rw-r--r--doc/s6-uevent-listener.html9
-rw-r--r--doc/s6-uevent-spawner.html2
3 files changed, 10 insertions, 8 deletions
diff --git a/doc/s6-devd.html b/doc/s6-devd.html
index 60fee03..ddbff78 100644
--- a/doc/s6-devd.html
+++ b/doc/s6-devd.html
@@ -33,9 +33,10 @@ interface does.
<li> s6-devd rewrites its command line into
<tt><a href="s6-uevent-listener.html">s6-uevent-listener</a>
<a href="s6-uevent-spawner.html">s6-uevent-spawner</a> <em>prog...</em></tt>,
-dispatching its options to the appropriate program; then it execs into
-this command line. </li>
- <li> The <a href="s6-uevent-listener.html">s6-uevent-listener</a>
+dispatching its options to the appropriate programs; then it execs into
+this new command line. It does nothing else: it's just a wrapper. </li>
+ <li> The first executed program,
+<a href="s6-uevent-listener.html">s6-uevent-listener</a>,
will listen to the netlink and pass the events sequentially to
<a href="s6-uevent-spawner.html">s6-uevent-spawner</a>, which will
spawn a <em>prog...</em> helper for every event. </li>
diff --git a/doc/s6-uevent-listener.html b/doc/s6-uevent-listener.html
index 9050e9f..6e6d0ab 100644
--- a/doc/s6-uevent-listener.html
+++ b/doc/s6-uevent-listener.html
@@ -35,9 +35,9 @@ helper program's standard input, using a simple format.
<em>prog</em>' stdin. </li>
<li> s6-uevent-listener binds to the netlink interface and listens for
hotplug events, as the <em>udev</em> program does. </li>
- <li> It tranmits event information to <em>prog</em> via the pipe. </li>
- <li> s6-uevent-listener, as well as <em>prog</em>, are long-lived programs.
-When it receives a SIGTERM, s6-uevent-listener stops listening; it will
+ <li> It transmits event information to <em>prog</em> via the pipe. </li>
+ <li> s6-uevent-listener, like <em>prog</em>, 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 <em>prog</em>. </li>
</ul>
@@ -50,7 +50,8 @@ print warnings every time the netlink interface sends something
unexpected. </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. Too large a buffer wastes kernel memory;
-too small a buffer risks losing events. The default is 65536. </li>
+too small a buffer risks losing events. The default is 65536 (which is on
+the large side). </li>
</ul>
<h2> Protocol </h2>
diff --git a/doc/s6-uevent-spawner.html b/doc/s6-uevent-spawner.html
index e9be726..3fbb545 100644
--- a/doc/s6-uevent-spawner.html
+++ b/doc/s6-uevent-spawner.html
@@ -70,7 +70,7 @@ alive after <em>k</em> more milliseconds, s6-uevent-spawner yells and exits 99.
<ul>
<li> The <em>prog...</em> helper should be very short-lived,
-even if you are not using the <tt>-t</tt> option to s6-devd. Since helpers are
+even if you are not using the <tt>-t</tt> option. Since helpers are
spawned sequentially, slow helpers can make events queue up and fill up
buffers. </li>
</ul>