about summary refs log tree commit diff
diff options
context:
space:
mode:
authorSiddhesh Poyarekar <siddhesh@redhat.com>2015-05-19 06:35:37 +0530
committerSiddhesh Poyarekar <siddhesh@redhat.com>2015-05-19 06:35:37 +0530
commit920d70128baa41ce6ce3b1b4771fe912f8d1691a (patch)
tree72f9baafcde55952ae08452bf3a513db00113567
parent46f894d8c60afcc06056a376340df2f378694551 (diff)
downloadglibc-920d70128baa41ce6ce3b1b4771fe912f8d1691a.tar.gz
glibc-920d70128baa41ce6ce3b1b4771fe912f8d1691a.tar.xz
glibc-920d70128baa41ce6ce3b1b4771fe912f8d1691a.zip
Add envz_remove to the libc manual
I was told that Ma Shimao submitted a patch to add envz_remove to the
libc manual, but the patch could not be accepted since he does not
have a copyright assignment in place.  I have been woefully behind on
libc-alpha recently and have not seen the patch or the discussion
thread.  I have also not read the man page for envz_remove, so
Alexandre Oliva asked me if I could write this independently and post
a patch.  The patch below is the result of the same - I have written
it based on the implementation in string/envz.c and Alex told me via
email that the function is AS, AC and MT-safe like envz_strip.

I assume Alex and Carlos cannot review this since they have been
tainted by the original patch (I haven't even tried to look for a link
to it since I don't want to be tainted) so someone else will have to
review this.  If there are no reviewers till the end of the week, I
will commit this since I believe there is a chance that there are no
other reviewers who haven't read that thread.

	* manual/string.texi (Envz Functions): Add envz_remove.
-rw-r--r--ChangeLog4
-rw-r--r--manual/string.texi8
2 files changed, 12 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 1c4f896689..68254a9a3d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2015-05-19  Siddhesh Poyarekar  <siddhesh@redhat.com>
+
+	* manual/string.texi (Envz Functions): Add envz_remove.
+
 2015-05-18  Roland McGrath  <roland@hack.frob.com>
 
 	* sysdeps/posix/opendir.c: Include <stdbool.h>.
diff --git a/manual/string.texi b/manual/string.texi
index 397c181c72..c53e73a0c7 100644
--- a/manual/string.texi
+++ b/manual/string.texi
@@ -2788,5 +2788,13 @@ The @code{envz_strip} function removes any null entries from @var{envz},
 updating @code{*@var{envz}} and @code{*@var{envz_len}}.
 @end deftypefun
 
+@comment envz.h
+@comment GNU
+@deftypefun {void} envz_remove (char **@var{envz}, size_t *@var{envz_len}, const char *@var{name})
+@safety{@prelim{}@mtsafe{}@asunsafe{@acsuheap{}}@acunsafe{@acsmem{}}}
+The @code{envz_remove} function removes an entry named @var{name} from
+@var{envz}, updating @code{*@var{envz}} and @code{*@var{envz_len}}.
+@end deftypefun
+
 @c FIXME this are undocumented:
 @c strcasecmp_l @safety{@mtsafe{}@assafe{}@acsafe{}} see strcasecmp