/[pcre]/code/trunk/maint/README
ViewVC logotype

Diff of /code/trunk/maint/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 507 by ph10, Wed Mar 10 16:08:01 2010 UTC revision 535 by ph10, Thu Jun 3 19:18:24 2010 UTC
# Line 25  Builducptable    A Perl script that crea Line 25  Builducptable    A Perl script that crea
25    
26  GenerateUtt.py   A Python script to generate part of the pcre_tables.c file  GenerateUtt.py   A Python script to generate part of the pcre_tables.c file
27                   that contains Unicode script names in a long string with                   that contains Unicode script names in a long string with
28                   offsets, which is tedious to maintain by hand.                   offsets, which is tedious to maintain by hand.
29    
30  ManyConfigTests  A shell script that runs "configure, make, test" a number of  ManyConfigTests  A shell script that runs "configure, make, test" a number of
31                   times with different configuration settings.                   times with different configuration settings.
32    
33  MultiStage2.py   A Python script that generates the file pcre_ucd.c from three  MultiStage2.py   A Python script that generates the file pcre_ucd.c from three
34                   Unicode data tables, which are themselves downloaded from the                   Unicode data tables, which are themselves downloaded from the
35                   Unicode web site. Run this script in the "maint" directory.                   Unicode web site. Run this script in the "maint" directory.
36                   The generated file contains the tables for a 2-stage lookup                   The generated file contains the tables for a 2-stage lookup
37                   of Unicode properties.                   of Unicode properties.
38    
39  README           This file.  README           This file.
40    
41  Unicode.tables   The files in this directory, DerivedGeneralCategory.txt,  Unicode.tables   The files in this directory, DerivedGeneralCategory.txt,
42                   Scripts.txt and UnicodeData.txt, were downloaded from the                   Scripts.txt and UnicodeData.txt, were downloaded from the
43                   Unicode web site. They contain information about Unicode                   Unicode web site. They contain information about Unicode
44                   characters and scripts.                   characters and scripts.
# Line 71  can be run to generate a new version of Line 71  can be run to generate a new version of
71  run to generate the tricky tables for inclusion in pcre_tables.c.  run to generate the tricky tables for inclusion in pcre_tables.c.
72    
73  If MultiStage2.py gives the error "ValueError: list.index(x): x not in list",  If MultiStage2.py gives the error "ValueError: list.index(x): x not in list",
74  the cause is usually a missing (or misspelt) name in the list of scripts. I  the cause is usually a missing (or misspelt) name in the list of scripts. I
75  couldn't find a straightforward list of scripts on the Unicode site, but  couldn't find a straightforward list of scripts on the Unicode site, but
76  there's a useful Wikipedia page that list them, and notes the Unicode version  there's a useful Wikipedia page that list them, and notes the Unicode version
77  in which they were introduced:  in which they were introduced:
78    
79  http://en.wikipedia.org/wiki/Unicode_scripts#Table_of_Unicode_scripts  http://en.wikipedia.org/wiki/Unicode_scripts#Table_of_Unicode_scripts
# Line 83  pcre_ucd.c work properly, using the data Line 83  pcre_ucd.c work properly, using the data
83  of test characters. The source file ucptest.c must be updated whenever new  of test characters. The source file ucptest.c must be updated whenever new
84  Unicode script names are added.  Unicode script names are added.
85    
86  Note also that both the pcresyntax.3 and pcrepattern.3 man pages contain lists  Note also that both the pcresyntax.3 and pcrepattern.3 man pages contain lists
87  of Unicode script names.  of Unicode script names.
88    
89    
# Line 94  This section contains a checklist of thi Line 94  This section contains a checklist of thi
94  distribution for a new release.  distribution for a new release.
95    
96  . Ensure that the version number and version date are correct in configure.ac.  . Ensure that the version number and version date are correct in configure.ac.
97    
98  . If new build options have been added, ensure that they are added to the CMake  . If new build options have been added, ensure that they are added to the CMake
99    files as well as to the autoconf files.    files as well as to the autoconf files.
100    
101  . Run ./autogen.sh to ensure everything is up-to-date.  . Run ./autogen.sh to ensure everything is up-to-date.
102    
103  . Compile and test with many different config options, and combinations of  . Compile and test with many different config options, and combinations of
104    options. The maint/ManyConfigTests script now encapsulates this testing.    options. The maint/ManyConfigTests script now encapsulates this testing.
105    
106  . Run perltest.pl on the test data for tests 1, 4, 6, and 11. The first two can  . Run perltest.pl on the test data for tests 1, 4, 6, and 11. The first two can
107    be run with Perl 5.8 or 5.10; the last two require Perl 5.10. The output    be run with Perl 5.8 or >= 5.10; the last two require Perl >= 5.10. The
108    should match the PCRE test output, apart from the version identification at    output should match the PCRE test output, apart from the version
109    the start of each test. The other tests are not Perl-compatible (they use    identification at the start of each test. The other tests are not
110    various PCRE-specific features or options).    Perl-compatible (they use various PCRE-specific features or options).
111    
112  . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest  . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest
113    valgrind", though that takes quite a long time.    valgrind", though that takes quite a long time.
# Line 130  distribution for a new release. Line 130  distribution for a new release.
130    used" warnings for the modules in which there is no call to memmove(). These    used" warnings for the modules in which there is no call to memmove(). These
131    can be ignored.    can be ignored.
132    
133  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),
134    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.
135    Many of these won't need changing, but over the long term things do change.    Many of these won't need changing, but over the long term things do change.
136    
137  . Man pages: Check all man pages for \ not followed by e or f or " because  . Man pages: Check all man pages for \ not followed by e or f or " because
138    that indicates a markup error. However, there is one exception: pcredemo.3,    that indicates a markup error. However, there is one exception: pcredemo.3,
139    which is created from the pcredemo.c program. It contains three instances    which is created from the pcredemo.c program. It contains three instances
140    of \\n.    of \\n.
141    
142  . When the release is built, test it on a number of different operating  . When the release is built, test it on a number of different operating
143    systems if possible, and using different compilers as well. For example,    systems if possible, and using different compilers as well. For example,
# Line 154  spaces). Then run "make distcheck" to cr Line 154  spaces). Then run "make distcheck" to cr
154  Double-check with "svn status", then create an SVN tagged copy:  Double-check with "svn status", then create an SVN tagged copy:
155    
156    svn copy svn://vcs.exim.org/pcre/code/trunk \    svn copy svn://vcs.exim.org/pcre/code/trunk \
157             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx
158    
159  Don't forget to update Freshmeat when the new release is out, and to tell  Don't forget to update Freshmeat when the new release is out, and to tell
160  webmaster@pcre.org and the mailing list. Also, update the list of version  webmaster@pcre.org and the mailing list. Also, update the list of version
161  numbers in Bugzilla (edit products).  numbers in Bugzilla (edit products).
162    
163    
# Line 186  others are relatively new. Line 186  others are relatively new.
186      over the existing "required byte" (reqbyte) feature that just remembers one      over the existing "required byte" (reqbyte) feature that just remembers one
187      byte.      byte.
188    
189    * These probably need to go in study():    * These probably need to go in pcre_study():
190    
191      o Remember an initial string rather than just 1 char?      o Remember an initial string rather than just 1 char?
192    
# Line 194  others are relatively new. Line 194  others are relatively new.
194        earlier one if common to all alternatives.        earlier one if common to all alternatives.
195    
196      o Friedl contains other ideas.      o Friedl contains other ideas.
197    
198      * pcre_study() does not set initial byte flags for Unicode property types
199        such as \p; I don't know how much benefit there would be for, for example,
200        setting the bits for 0-9 and all bytes >= xC0 when a pattern starts with
201        \p{N}.
202    
203      * There is scope for more "auto-possessifying" in connection with \p and \P.
204    
205  . If Perl gets to a consistent state over the settings of capturing sub-  . If Perl gets to a consistent state over the settings of capturing sub-
206    patterns inside repeats, see if we can match it. One example of the    patterns inside repeats, see if we can match it. One example of the
207    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE
# Line 205  others are relatively new. Line 212  others are relatively new.
212    
213  . Unicode  . Unicode
214    
   * Note that in Perl, \s matches \pZ and similarly for \d, \w and the POSIX  
     character classes. For the moment, I've chosen not to support this for  
     backward compatibility, for speed, and because it would be messy to  
     implement.  
   
215    * A different approach to Unicode might be to use a typedef to do everything    * A different approach to Unicode might be to use a typedef to do everything
216      in unsigned shorts instead of unsigned chars. Actually, we'd have to have a      in unsigned shorts instead of unsigned chars. Actually, we'd have to have a
217      new typedef to distinguish data from bits of compiled pattern that are in      new typedef to distinguish data from bits of compiled pattern that are in
# Line 271  others are relatively new. Line 273  others are relatively new.
273    
274  . Someone suggested --disable-callout to save code space when callouts are  . Someone suggested --disable-callout to save code space when callouts are
275    never wanted. This seems rather marginal.    never wanted. This seems rather marginal.
276    
277  . Check names that consist entirely of digits: PCRE allows, but do Perl and  . Check names that consist entirely of digits: PCRE allows, but do Perl and
278    Python, etc?    Python, etc?
279    
280  . A user suggested a parameter to limit the length of string matched, for  . A user suggested a parameter to limit the length of string matched, for
281    example if the parameter is N, the current match should fail if the matched    example if the parameter is N, the current match should fail if the matched
282    substring exceeds N. This could apply to both match functions. The value    substring exceeds N. This could apply to both match functions. The value
283    could be a new field in the extra block.    could be a new field in the extra block.
284    
285  . Callouts with arguments: (?Cn:ARG) for instance.  . Callouts with arguments: (?Cn:ARG) for instance.
286    
287  . A user is going to supply a patch to generalize the API for user-specific  . A user is going to supply a patch to generalize the API for user-specific
288    memory allocation so that it is more flexible in threaded environments. This    memory allocation so that it is more flexible in threaded environments. This
289    was promised a long time ago, and never appeared...    was promised a long time ago, and never appeared...
290    
291  . Write a function that generates random matching strings for a compiled regex.  . Write a function that generates random matching strings for a compiled regex.
292    
293  . Write a wrapper to maintain a structure with specified runtime parameters,  . Write a wrapper to maintain a structure with specified runtime parameters,
294    such as recurse limit, and pass these to PCRE each time it is called. Also    such as recurse limit, and pass these to PCRE each time it is called. Also
295    maybe malloc and free. A user sent a prototype.    maybe malloc and free. A user sent a prototype.
296    
297  . Pcregrep: an option to specify the output line separator, either as a string  . Pcregrep: an option to specify the output line separator, either as a string
298    or select from a fixed list. This is not dead easy, because at the moment it    or select from a fixed list. This is not dead easy, because at the moment it
299    outputs whatever is in the input file.    outputs whatever is in the input file.
300    
301  . Improve the code for duplicate checking in pcre_dfa_exec(). An incomplete,  . Improve the code for duplicate checking in pcre_dfa_exec(). An incomplete,
302    non-thread-safe patch showed that this can help performance for patterns    non-thread-safe patch showed that this can help performance for patterns
303    where there are many alternatives. However, a simple thread-safe    where there are many alternatives. However, a simple thread-safe
304    implementation that I tried made things worse in many simple cases, so this    implementation that I tried made things worse in many simple cases, so this
305    is not an obviously good thing.    is not an obviously good thing.
306    
307  . Make the longest lookbehind available via pcre_fullinfo(). This is not  . Make the longest lookbehind available via pcre_fullinfo(). This is not
308    straightforward because lookbehinds can be nested inside lookbehinds. This    straightforward because lookbehinds can be nested inside lookbehinds. This
309    case will have to be identified, and the amounts added. This should then give    case will have to be identified, and the amounts added. This should then give
310    the maximum possible lookbehind length. The reason for wanting this is to    the maximum possible lookbehind length. The reason for wanting this is to
311    help when implementing multi-segment matching using pcre_exec() with partial    help when implementing multi-segment matching using pcre_exec() with partial
312    matching and overlapping segments.    matching and overlapping segments.
313    
314  . PCRE cannot at present distinguish between subpatterns with different names,  . PCRE cannot at present distinguish between subpatterns with different names,
315    but the same number (created by the use of ?|). In order to do so, a way of    but the same number (created by the use of ?|). In order to do so, a way of
316    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.
317      Now that (*MARK) has been implemented, it can perhaps be used as a way round
318  . Instead of having #ifdef HAVE_CONFIG_H in each module, put #include    this problem.
319    
320    . Instead of having #ifdef HAVE_CONFIG_H in each module, put #include
321    "something" and the the #ifdef appears only in one place, in "something".    "something" and the the #ifdef appears only in one place, in "something".
   
 . Support for (*MARK) and arguments for (*PRUNE) and friends.  
322    
323  Philip Hazel  Philip Hazel
324  Email local part: ph10  Email local part: ph10
325  Email domain: cam.ac.uk  Email domain: cam.ac.uk
326  Last updated: 10 March 2010  Last updated: 03 June 2010

Legend:
Removed from v.507  
changed lines
  Added in v.535

  ViewVC Help
Powered by ViewVC 1.1.5