Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@httpd.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1026642 - /httpd/httpd/trunk/include/httpd.h
Date: Sat, 23 Oct 2010 16:38:03 -0000
To: cvs@httpd.apache.org
From: sf@apache.org
Message-Id: <20101023163803.DAA0C2388A4B@eris.apache.org>

Author: sf
Date: Sat Oct 23 16:38:03 2010
New Revision: 1026642

URL: http://svn.apache.org/viewvc?rev=1026642&view=rev
Log:
Clarify usage of ap_pregcomp/ap_pregfree

Modified:
    httpd/httpd/trunk/include/httpd.h

Modified: httpd/httpd/trunk/include/httpd.h
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/include/httpd.h?rev=1026642&r1=1026641&r2=1026642&view=diff
==============================================================================
--- httpd/httpd/trunk/include/httpd.h (original)
+++ httpd/httpd/trunk/include/httpd.h Sat Oct 23 16:38:03 2010
@@ -1706,7 +1706,8 @@ AP_DECLARE(char *) ap_pbase64decode(apr_
 AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string); 
 
 /**
- * Compile a regular expression to be used later
+ * Compile a regular expression to be used later. The regex is freed when
+ * the pool is destroyed.
  * @param p The pool to allocate from
  * @param pattern the regular expression to compile
  * @param cflags The bitwise or of one or more of the following:
@@ -1724,6 +1725,8 @@ AP_DECLARE(ap_regex_t *) ap_pregcomp(apr
  * Free the memory associated with a compiled regular expression
  * @param p The pool the regex was allocated from
  * @param reg The regular expression to free
+ * @note This function is only necessary if the regex should be cleaned
+ * up before the pool
  */
 AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);