changeset 11018:43c1f914e293

Update docstring for regexp, regexprep.
author Rik <octave@nomad.inbox5.com>
date Fri, 24 Sep 2010 21:46:07 -0700
parents 60141d49a38d
children 630dc1933fe6
files src/ChangeLog src/DLD-FUNCTIONS/regexp.cc
diffstat 2 files changed, 18 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Fri Sep 24 21:39:22 2010 +0200
+++ b/src/ChangeLog	Fri Sep 24 21:46:07 2010 -0700
@@ -1,3 +1,8 @@
+2010-09-24  Rik <octave@nomad.inbox5.com>
+
+	* DLD-FUNCTIONS/regexp.cc (regexp, regexprep): Update docstring to 
+	discuss limits when not compiled with PCRE.
+
 2010-09-23  John W. Eaton  <jwe@octave.org>
 
 	* Makefile.am (ALL_DEF_FILES): New variable.
--- a/src/DLD-FUNCTIONS/regexp.cc	Fri Sep 24 21:39:22 2010 +0200
+++ b/src/DLD-FUNCTIONS/regexp.cc	Fri Sep 24 21:46:07 2010 -0700
@@ -882,7 +882,6 @@
   "-*- texinfo -*-\n\
 @deftypefn  {Loadable Function} {[@var{s}, @var{e}, @var{te}, @var{m}, @var{t}, @var{nm}] =} regexp (@var{str}, @var{pat})\n\
 @deftypefnx {Loadable Function} {[@dots{}] =} regexp (@var{str}, @var{pat}, @var{opts}, @dots{})\n\
-\n\
 Regular expression string matching.  Matches @var{pat} in @var{str} and\n\
 returns the position and matching substrings or empty values if there are\n\
 none.\n\
@@ -1020,16 +1019,19 @@
 \n\
 @item lineanchors\n\
 Match the anchor characters at the beginning and end of the line.\n\
+Only available if Octave is compiled with Perl Compatible Regular Expressions.\n\
 \n\
 @item dotall\n\
 The character @code{.} matches the newline character.\n\
 \n\
 @item dotexceptnewline\n\
 The character @code{.} matches all but the newline character.\n\
+Only available if Octave is compiled with Perl Compatible Regular Expressions.\n\
 \n\
 @item freespacing\n\
 The pattern can include arbitrary whitespace and comments starting with\n\
 @code{#}.\n\
+Only available if Octave is compiled with Perl Compatible Regular Expressions.\n\
 \n\
 @item literalspacing\n\
 The pattern is taken literally.\n\
@@ -1231,7 +1233,7 @@
 \n\
 Case insensitive regular expression string matching.  Matches @var{pat} in\n\
 @var{str} and returns the position and matching substrings or empty values\n\
-if there are none.  @xref{doc-regexp,,regexp}, for more details\n\
+if there are none.  @xref{doc-regexp,,regexp}, for more details.\n\
 @end deftypefn")
 {
   octave_value_list retval;
@@ -1576,18 +1578,13 @@
 DEFUN_DLD (regexprep, args, ,
   "-*- texinfo -*-\n\
 @deftypefn {Loadable Function} {@var{string} =} regexprep (@var{string}, @var{pat}, @var{repstr}, @var{options})\n\
-Replace matches of @var{pat} in  @var{string} with @var{repstr}.\n\
-\n\
+Replace matches of @var{pat} in @var{string} with @var{repstr}.\n\
 \n\
 The replacement can contain @code{$i}, which substitutes\n\
 for the ith set of parentheses in the match string.  E.g.,\n\
 \n\
 @example\n\
-@group\n\
-\n\
    regexprep(\"Bill Dunn\",'(\\w+) (\\w+)','$2, $1')\n\
-\n\
-@end group\n\
 @end example\n\
 \n\
 @noindent\n\
@@ -1607,16 +1604,23 @@
 Alternatively, use (?i) or (?-i) in the pattern.\n\
 \n\
 @item lineanchors and stringanchors\n\
-Whether characters ^ and $ match the beginning and ending of lines.\n\
+Whether characters ^ and $ match the start/end of lines or of the entire\n\
+string.\n\
 Alternatively, use (?m) or (?-m) in the pattern.\n\
+'lineanchors' is only available when Octave is compiled with\n\
+Perl Compatible Regular Expressions.\n\
 \n\
 @item dotexceptnewline and dotall\n\
 Whether . matches newlines in the string.\n\
 Alternatively, use (?s) or (?-s) in the pattern.\n\
+'dotexceptnewline' is only available when Octave is compiled with\n\
+Perl Compatible Regular Expressions.\n\
 \n\
 @item freespacing or literalspacing\n\
 Whether whitespace and # comments can be used to make the regular expression\n\
 more readable.  Alternatively, use (?x) or (?-x) in the pattern.\n\
+'freespacing' is only available when Octave is compiled with\n\
+Perl Compatible Regular Expressions.\n\
 \n\
 @end table\n\
 @seealso{regexp,regexpi,strrep}\n\