Update documentation in regex.h

3 files changed, 25 insertions, 12 deletions

diff --git a/ChangeLog b/ChangeLog
index 02f4737c41..1ab3ae1d6c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2011-05-20  Ulrich Drepper  <drepper@gmail.com>
+
+	[BZ #11857]
+	* posix/regex.h: Fix comments with documentation of user-accessible
+	fields after compilation and describe correct free'ing of pattern
+	after re_compile_pattern.
+	Patch by Reuben Thomas <rrt@sc3d.org>.
+
 2011-05-18  Ryan S. Arnold  <rsa@us.ibm.com>
 
 	* sysdeps/powerpc/powerpc64/Makefile (no-special-regs): Add -mno-vsx
diff --git a/NEWS b/NEWS
index a5d803498d..745f333970 100644
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,4 @@
-GNU C Library NEWS -- history of user-visible changes.  2011-5-18
+GNU C Library NEWS -- history of user-visible changes.  2011-5-20
 Copyright (C) 1992-2009, 2010, 2011 Free Software Foundation, Inc.
 See the end for copying conditions.
 
@@ -10,13 +10,13 @@ Version 2.14
 * The following bugs are resolved with this release:
 
   386, 6420, 7101, 9730, 9732, 9809, 10138, 10149, 10157, 11257, 11258,
-  11487, 11532, 11578, 11653, 11668, 11697, 11724, 11820, 11837, 11892,
-  11895, 11901, 11945, 11947, 11952, 11987, 12052, 12083, 12158, 12178,
-  12200, 12346, 12393, 12420, 12432, 12445, 12449, 12453, 12454, 12460,
-  12469, 12489, 12509, 12510, 12511, 12518, 12527, 12541, 12545, 12551,
-  12582, 12583, 12587, 12597, 12601, 12611, 12625, 12626, 12631, 12650,
-  12653, 12655, 12660, 12681, 12685, 12711, 12713, 12714, 12717, 12723,
-  12724, 12734, 12738, 12746, 12766, 12775
+  11487, 11532, 11578, 11653, 11668, 11697, 11724, 11820, 11837, 11857,
+  11892, 11895, 11901, 11945, 11947, 11952, 11987, 12052, 12083, 12158,
+  12178, 12200, 12346, 12393, 12420, 12432, 12445, 12449, 12453, 12454,
+  12460, 12469, 12489, 12509, 12510, 12511, 12518, 12527, 12541, 12545,
+  12551, 12582, 12583, 12587, 12597, 12601, 12611, 12625, 12626, 12631,
+  12650, 12653, 12655, 12660, 12681, 12685, 12711, 12713, 12714, 12717,
+  12723, 12724, 12734, 12738, 12746, 12766, 12775
 
 * The RPC implementation in libc is obsoleted.  Old programs keep working
   but new programs cannot be linked with the routines in libc anymore.
diff --git a/posix/regex.h b/posix/regex.h
index 21fa3cf1ce..32804b9b82 100644
--- a/posix/regex.h
+++ b/posix/regex.h
@@ -339,9 +339,9 @@ typedef enum
 
 /* This data structure represents a compiled pattern.  Before calling
    the pattern compiler, the fields `buffer', `allocated', `fastmap',
-   `translate', and `no_sub' can be set.  After the pattern has been
-   compiled, the `re_nsub' field is available.  All other fields are
-   private to the regex routines.  */
+   and `translate' can be set.  After the pattern has been compiled,
+   the fields `re_nsub', `not_bol' and `not_eol' are available.  All
+   other fields are private to the regex routines.  */
 
 #ifndef RE_TRANSLATE_TYPE
 # define __RE_TRANSLATE_TYPE unsigned char *
@@ -466,7 +466,12 @@ extern reg_syntax_t re_set_syntax (reg_syntax_t __syntax);
 
 /* Compile the regular expression PATTERN, with length LENGTH
    and syntax given by the global `re_syntax_options', into the buffer
-   BUFFER.  Return NULL if successful, and an error string if not.  */
+   BUFFER.  Return NULL if successful, and an error string if not.
+
+   To free the allocated storage, you must call `regfree' on BUFFER.
+   Note that the translate table must either have been initialised by
+   `regcomp', with a malloc'ed value, or set to NULL before calling
+   `regfree'.  */
 extern const char *re_compile_pattern (const char *__pattern, size_t __length,
 				       struct re_pattern_buffer *__buffer);