[PATCH] Add envz_remove to the libc manual

[Siddhesh Poyarekar]

On Thu, Mar 19, 2015 at 12:42:29AM +0100, Florian Weimer wrote:
> The safety annotations are incorrect, see envz_add and argz_delete:
> 
> @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
> @c Calls envz_remove, which calls enz_entry and argz_delete, and then
> @c argz_add or equivalent code that reallocs and appends name=value.
> 
> @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
> @c Calls free if no argument is left.

Right, I'll push the following patch with the annotations fixed up.

Siddhesh

	* manual/string.texi (Envz Functions): Add envz_remove.

diff --git a/manual/string.texi b/manual/string.texi
index 397c181..c53e73a 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
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 473 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/libc-alpha/attachments/20150518/6f1770f2/attachment.sig>