From 51e253133a87a72cfde9ce6bd8c12544b54721cb Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Fri, 7 Apr 2023 01:17:04 +0000
Subject:  Add selfpipe_fd(), refactor selfpipe

Signed-off-by: Laurent Bercot <ska@appnovation.com>
---
 doc/index.html              |  2 +-
 doc/libstddjb/selfpipe.html | 15 +++++++++++++++
 doc/upgrade.html            |  6 ++++++
 3 files changed, 22 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/index.html b/doc/index.html
index d61c875..7b7ce35 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -60,7 +60,7 @@ with a standard C development environment </li>
 <h3> Download </h3>
 
 <ul>
- <li> The current released version of skalibs is <a href="skalibs-2.13.1.1.tar.gz">2.13.1.1</a>. </li>
+ <li> The current released version of skalibs is <a href="skalibs-2.13.2.0.tar.gz">2.13.2.0</a>. </li>
  <li> Alternatively, you can checkout a copy of the
 <a href="//git.skarnet.org/cgi-bin/cgit.cgi/skalibs/">skalibs
 git repository</a>:
diff --git a/doc/libstddjb/selfpipe.html b/doc/libstddjb/selfpipe.html
index 7c13e0e..54c0f36 100644
--- a/doc/libstddjb/selfpipe.html
+++ b/doc/libstddjb/selfpipe.html
@@ -182,6 +182,21 @@ it's a serious one and your system has become very unstable.
 is positive, it is the number of the signal that was caught.
 </p>
 
+<h3> Accessing the selfpipe </h3>
+
+<pre>
+int fd = selfpipe_fd() ;
+</pre>
+
+<p>
+ Sometimes you need to access the fd of the selfpipe in two
+very distinct translation units (typically to poll on it), and you
+rightly don't want to add a global variable to store it, especially
+since it's already stored in a global internal variable in skalibs.
+No need to bloat your binary anymore: <tt>selfpipe_fd()</tt> will
+now retrieve the value for you, wherever you are.
+</p>
+
 <h3> Finishing </h3>
 
 <pre>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 66cecd3..ed83b9b 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -17,6 +17,12 @@
 </p>
 
 
+<h2> in 2.13.2.0 </h2>
+
+<ul>
+ <li> New accessor function: <tt>selfpipe_fd()</tt> </li>
+</ul>
+
 <h2> in 2.13.1.1 </h2>
 
 <ul>
-- 
cgit v1.2.3