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/libnsss/index.html | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

(limited to 'doc/libnsss/index.html')

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
-- 
cgit v1.3.1