[Bug regex/11857] New: Missing documentation in regex.h

["rrt at sc3d dot org" <sourceware-bugzilla at sourceware dot org>]

The attached patch addresses the following deficiencies in regex.h's documentation:

1. It mentions that re_compile-allocated pattern buffers should be freed with
regfree. (This may seem surprising, as regfree is in the POSIX API, not the GNU
API. Eric Blake, 20 Jul 10, wrote to bug-gnulib@gnu.org:

Odd or not, that is the correct usage pattern.  regfree() is the correct
way to release memory allocated by re_compile.

)

2. It explains that when using regfree, the translate member must either be NULL
or a malloced pointer. (See http://sourceware.org/bugzilla/show_bug.cgi?id=5718)

3. It adds not_bol, not_eol and newline_anchor to the list of fields that are
user-accessible after compilation (thanks to Bruno Haible for answering my
question about this on bug-gnulib 29 Jul 10).

Note that this patch only changes comments, not code.

-- 
           Summary: Missing documentation in regex.h
           Product: glibc
           Version: unspecified
            Status: NEW
          Severity: minor
          Priority: P2
         Component: regex
        AssignedTo: drepper at redhat dot com
        ReportedBy: rrt at sc3d dot org
                CC: glibc-bugs-regex at sources dot redhat dot com,glibc-
                    bugs at sources dot redhat dot com


http://sourceware.org/bugzilla/show_bug.cgi?id=11857

------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.