/[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 372 by ph10, Tue Aug 26 11:49:38 2008 UTC revision 491 by ph10, Mon Mar 1 17:45:08 2010 UTC
# Line 36  MultiStage2.py   A Python script that ge Line 36  MultiStage2.py   A Python script that ge
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.
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
# Line 62  Updating to a new Unicode release Line 64  Updating to a new Unicode release
64  ---------------------------------  ---------------------------------
65    
66  When there is a new release of Unicode, the files in Unicode.tables must be  When there is a new release of Unicode, the files in Unicode.tables must be
67  refreshed from the web site. If the new version of Unicode adds new character  refreshed from the web site. If the new version of Unicode adds new character
68  scripts, the source file ucp.h and both the MultiStage2.py and the  scripts, the source file ucp.h and both the MultiStage2.py and the
69  GenerateUtt.py scripts must be edited to add the new names. Then the  GenerateUtt.py scripts must be edited to add the new names. Then MultiStage2.py
70  MultiStage2.py script can then be run to generate a new version of pcre_ucd.c  can be run to generate a new version of pcre_ucd.c, and GenerateUtt.py can be
71  and the GenerateUtt.py can be run to generate the tricky tables for inclusion  run to generate the tricky tables for inclusion in pcre_tables.c.
72  in pcre_tables.c.  
73    If MultiStage2.py gives the error "ValueError: list.index(x): x not in list",
74  The ucptest program can then be compiled and used to check that the new tables  the cause is usually a missing (or misspelt) name in the list of scripts. I
75  in pcre_ucd.c work properly, using the data files in ucptestdata to check a  couldn't find a straightforward list of scripts on the Unicode site, but
76  number of test characters.  there's a useful Wikipedia page that list them, and notes the Unicode version
77    in which they were introduced:
78    
79    http://en.wikipedia.org/wiki/Unicode_scripts#Table_of_Unicode_scripts
80    
81    The ucptest program can be compiled and used to check that the new tables in
82    pcre_ucd.c work properly, using the data files in ucptestdata to check a number
83    of test characters. The source file ucptest.c must be updated whenever new
84    Unicode script names are added.
85    
86    Note also that both the pcresyntax.3 and pcrepattern.3 man pages contain lists
87    of Unicode script names.
88    
89    
90  Preparing for a PCRE release  Preparing for a PCRE release
# Line 80  Preparing for a PCRE release Line 93  Preparing for a PCRE release
93  This section contains a checklist of things that I consult before building a  This section contains a checklist of things that I consult before building a
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.
   ChangeLog, and NEWS.  
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.
# Line 91  distribution for a new release. Line 103  distribution for a new release.
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 and 4. The output should match  . Run perltest.pl on the test data for tests 1, 4, 6, and 11. The first two can
107    the PCRE test output, apart from the version identification at the top. The    be run with Perl 5.8 or 5.10; the last two require Perl 5.10. The output
108    other tests are not Perl-compatible (they use various special PCRE options).    should match the PCRE test output, apart from the version identification at
109      the start of each test. The other tests are not Perl-compatible (they use
110      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 116  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 date), INSTALL,  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),
134    LICENCE, NEWS (check date), NON-UNIX-USE, and README. Many of these won't    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.
135    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.    that indicates a markup error.
# Line 138  spaces). Then run "make distcheck" to cr Line 152  spaces). Then run "make distcheck" to cr
152  Double-check with "svn status", then create an SVN tagged copy:  Double-check with "svn status", then create an SVN tagged copy:
153    
154    svn copy svn://vcs.exim.org/pcre/code/trunk \    svn copy svn://vcs.exim.org/pcre/code/trunk \
155             svn://vcs.exim.org/pcre/code/tags/pcre-7.x             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx
156    
157  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
158  webmaster@pcre.org and the mailing list.  webmaster@pcre.org and the mailing list.
# Line 166  others are relatively new. Line 180  others are relatively new.
180      to have little effect, and maybe makes things worse.      to have little effect, and maybe makes things worse.
181    
182    * "Ends with literal string" - note that a single character doesn't gain much    * "Ends with literal string" - note that a single character doesn't gain much
183      over the existing "required byte" (reqbyte) feature that just saves one      over the existing "required byte" (reqbyte) feature that just remembers one
184      byte.      byte.
185    
186    * These probably need to go in study():    * These probably need to go in study():
# Line 176  others are relatively new. Line 190  others are relatively new.
190      o A required byte from alternatives - not just the last char, but an      o A required byte from alternatives - not just the last char, but an
191        earlier one if common to all alternatives.        earlier one if common to all alternatives.
192    
     o Minimum length of subject needed.  
   
193      o Friedl contains other ideas.      o Friedl contains other ideas.
194    
195  . 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-
196    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
197    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE
# Line 213  others are relatively new. Line 225  others are relatively new.
225    
226    * Option to use NUL as a line terminator in subject strings. This could now    * Option to use NUL as a line terminator in subject strings. This could now
227      be done relatively easily since the extension to support LF, CR, and CRLF.      be done relatively easily since the extension to support LF, CR, and CRLF.
228      If this is done, a suitable option for pcregrep is also required.      If it is done, a suitable option for pcregrep is also required.
229    
230  . Option to provide the pattern with a length instead of with a NUL terminator.  . Option to provide the pattern with a length instead of with a NUL terminator.
231    This probably affects quite a few places in the code.    This affects quite a few places in the code and is not trivial.
232    
233  . Catch SIGSEGV for stack overflows?  . Catch SIGSEGV for stack overflows?
234    
# Line 231  others are relatively new. Line 243  others are relatively new.
243    preceded by a blank line, instead of adding it to every matched line, and (b)    preceded by a blank line, instead of adding it to every matched line, and (b)
244    support --outputfile=name.    support --outputfile=name.
245    
246  . Consider making UTF-8 and UCP the default for PCRE n.0 for some n > 7.  . Consider making UTF-8 and UCP the default for PCRE n.0 for some n > 8.
247    
248  . Add a user pointer to pcre_malloc/free functions -- some option would be  . Add a user pointer to pcre_malloc/free functions -- some option would be
249    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 268  others are relatively new. Line 280  others are relatively new.
280  . Callouts with arguments: (?Cn:ARG) for instance.  . Callouts with arguments: (?Cn:ARG) for instance.
281    
282  . 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
283    memory allocation so that it is more flexible in threaded environments.    memory allocation so that it is more flexible in threaded environments. Thiw
284      was promised a long time ago, and never appeared...
285    
286    . Write a function that generates random matching strings for a compiled regex.
287    
288    . Write a wrapper to maintain a structure with specified runtime parameters,
289      such as recurse limit, and pass these to PCRE each time it is called. Also
290      maybe malloc and free. A user sent a prototype.
291    
292    . Pcregrep: an option to specify the output line separator, either as a string
293      or select from a fixed list. This is not dead easy, because at the moment it
294      outputs whatever is in the input file.
295    
296    . Improve the code for duplicate checking in pcre_dfa_exec(). An incomplete,
297      non-thread-safe patch showed that this can help performance for patterns
298      where there are many alternatives. However, a simple thread-safe
299      implementation that I tried made things worse in many simple cases, so this
300      is not an obviously good thing.
301    
302    . Make the longest lookbehind available via pcre_fullinfo(). This is not
303      straightforward because lookbehinds can be nested inside lookbehinds. This
304      case will have to be identified, and the amounts added. This should then give
305      the maximum possible lookbehind length. The reason for wanting this is to
306      help when implementing multi-segment matching using pcre_exec() with partial
307      matching and overlapping segments.
308    
309    . PCRE cannot at present distinguish between subpatterns with different names,
310      but the same number (created by the use of ?|). In order to do so, a way of
311      remembering *which* subpattern numbered n matched is needed. Bugzilla #760.
312    
313  Philip Hazel  Philip Hazel
314  Email local part: ph10  Email local part: ph10
315  Email domain: cam.ac.uk  Email domain: cam.ac.uk
316  Last updated: 26 August 2008  Last updated: 26 September 2009

Legend:
Removed from v.372  
changed lines
  Added in v.491

  ViewVC Help
Powered by ViewVC 1.1.5