Document best practice for disconnected NSS modules.

NSS modules which can run in disconnected modes should
return NSS_STATUS_NOTFOUND and SUCCESS in order to follow
best practice for such modules and ensure user applications
can have these modules configured without causing problems
if the data sources are not connected.

diff --git a/ChangeLog b/ChangeLog
index fd421fcc5df8249b54912d5ee335ada4e78ec75b..9140faf3844c0a77ed8695cf6448266df9b10945 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2015-12-10  Carlos O'Donell  <carlos@redhat.com>
+
+       * manual/nss.texi (NSS Modules Interface): Document
+       NSS_STATUS_NOTFOUND and SUCCESS.
+
 2015-12-09  Mike FABIAN  <mfabian@redhat.com>
 
        [BZ 18568]

diff --git a/manual/nss.texi b/manual/nss.texi
index bf3e69dee537a716f406a54fd74de500b8d97140..66dcceffe01f225f078e88dd006bb90e80c85723 100644 (file)
--- a/manual/nss.texi
+++ b/manual/nss.texi
@@ -448,6 +448,13 @@ The function should be called again with a larger buffer.
 @item
 @code{NSS_STATUS_NOTFOUND} @tab
         @code{ENOENT} @tab The requested entry is not available.
+
+@item
+@code{NSS_STATUS_NOTFOUND} @tab
+       @code{SUCCESS} @tab There are no entries.
+Use this to avoid returning errors for inactive services which may
+be enabled at a later time. This is not the same as the service
+being temporarily unavailable.
 @end multitable
 
 These are proposed values.  There can be other error codes and the