From 57abdf3eaa424deafda497a4a896328238353e18 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Sun, 6 Dec 2020 15:32:11 +0000
Subject:  Prepare for 0.1.0.0, add --enable-libc-includes configure switch

 pwd.h, grp.h and shadow.h will not overwrite the libc headers
by default anymore; you need to explicitly add the switch.
---
 doc/index.html         |  8 ++++----
 doc/libnsss/index.html | 25 ++++++++++++++++++++++---
 doc/upgrade.html       | 10 ++++++++--
 3 files changed, 34 insertions(+), 9 deletions(-)

(limited to 'doc')

diff --git a/doc/index.html b/doc/index.html
index 9c155a1..62b37bd 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -81,11 +81,11 @@ functions.
  <li> A POSIX-compliant system with a standard C development environment </li>
  <li> GNU make, version 3.81 or later </li>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.9.2.1 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>
  <li> <a href="//skarnet.org/software/s6/">s6</a> version
-2.9.1.0 or later. It's a <em>run-time</em> requirement only, to run
+2.10.0.0 or later. It's a <em>run-time</em> requirement only, to run
 the nsssd service (and can be done without if you have a suitable replacement
 for <a href="//skarnet.org/software/s6/s6-ipcserver">s6-ipcserver</a>). </li>
 </ul>
@@ -94,13 +94,13 @@ for <a href="//skarnet.org/software/s6/s6-ipcserver">s6-ipcserver</a>). </li>
 
 <p>
  nsss is free software. It is available under the
-<a href="http://opensource.org/licenses/ISC">ISC license</a>.
+<a href="https://opensource.org/licenses/ISC">ISC license</a>.
 </p>
 
 <h3> Download </h3>
 
 <ul>
- <li> The current released version of nsss is <a href="nsss-0.0.2.2.tar.gz">0.0.2.2</a>. </li>
+ <li> The current released version of nsss is <a href="nsss-0.1.0.0.tar.gz">0.1.0.0</a>. </li>
  <li> Alternatively, you can checkout a copy of the
 <a href="//git.skarnet.org/cgi-bin/cgit.cgi/nsss/">nsss
 git repository</a>:
diff --git a/doc/libnsss/index.html b/doc/libnsss/index.html
index 3514c42..bbe5029 100644
--- a/doc/libnsss/index.html
+++ b/doc/libnsss/index.html
@@ -102,6 +102,17 @@ will automatically be aliased to <tt>nsss_all_getpwnam()</tt>, and
 the other functions will be aliased similarly.
 </p>
 
+<p>
+ <tt>pwd.h</tt> can be found in the <tt>nsss/</tt> subdirectory of
+the header installation directory; if the <tt>--enable-libc-includes</tt>
+option has been given to configure, it can also be found directly
+in that directory. (Example: <tt>/usr/include/nsss/pwd.h</tt> is
+always installed, but if the option has been given at nsss build time,
+<tt>/usr/include/pwd.h</tt> is also installed and replaces the
+version provided by the libc.) This also applies to the <tt>grp.h</tt>
+and <tt>shadow.h</tt> files.
+</p>
+
 <p>
  If the NSSS_DISABLE_SWITCH macro is defined before inclusion of the
 nsss headers, then <tt>getpwnam()</tt> will be aliased to
@@ -121,9 +132,17 @@ functions will follow the same pattern.
 are visible in your header search path. </li>
  <li> Use <tt>#include &lt;nsss/nsss.h&gt;</tt> </li>
  <li> To use the standard <tt>pwd.h</tt> interface, you can
-just <tt>#include &lt;pwd.h&gt;</tt>, which will work as long
-as the <tt>nsss/pwd.h</tt> header is accessible in your header
-search path. </li>
+just <tt>#include &lt;pwd.h&gt;</tt>, which will work:
+  <ul>
+   <li> either if the <tt>--enable-libc-includes</tt> option
+has been given at nsss build time </li>
+   <li> or if you give the <tt>-I/usr/include/nsss</tt> option
+to your compiler. (Depending on your standard header location,
+specify that the header search path should include the
+<tt>nsss</tt> subdirectory of that location.) This is useful when
+the administrator did not want to overwrite the libc-provided
+<tt>pwd.h</tt> file when they installed nsss. </li>
+  </ul> </li>
  <li> Same thing for <tt>grp.h</tt> and <tt>shadow.h</tt>. </li>
  <li> If don't want to use the nsss-all implementation of
 "try nsss-switch and fall back to nsss-unix if it fails", then
diff --git a/doc/upgrade.html b/doc/upgrade.html
index b0ae772..00fffe3 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,11 +18,17 @@
 
 <h1> What has changed in nsss </h1>
 
-<h2> in 0.0.2.3 </h2>
+<h2> in 0.1.0.0 </h2>
 
 <ul>
  <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> dependency bumped to
-2.9.2.1. </li>
+2.10.0.0. </li>
+ <li> <a href="//skarnet.org/software/s6/">s6</a> optional dependency bumped to
+2.10.0.0. </li>
+ <li> The <tt>pwd.h</tt>, <tt>grp.h</tt> and <tt>shadow.h</tt> header files are
+not installed by default anymore. You now need to explicitly give the
+<tt>--enable-libc-includes</tt> configure option in order to install them. The
+point of this change is to avoid overwriting libc headers accidentally. </li>
 </ul>
 
 <h2> in 0.0.2.2 </h2>
-- 
cgit v1.3.1