/[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 350 by ph10, Wed Jul 2 19:18:41 2008 UTC revision 507 by ph10, Wed Mar 10 16:08:01 2010 UTC
# Line 1  Line 1 
1  MAINTENANCE README FOR PCRE  MAINTENANCE README FOR PCRE
2  ---------------------------  ===========================
3    
4  The files in the "maint" directory of the PCRE source contain data, scripts,  The files in the "maint" directory of the PCRE source contain data, scripts,
5  and programs that are used for the maintenance of PCRE, but which do not form  and programs that are used for the maintenance of PCRE, but which do not form
# Line 14  also contains some notes for maintainers Line 14  also contains some notes for maintainers
14    
15    
16  Files in the maint directory  Files in the maint directory
17  ----------------------------  ============================
18    
19  ----------------- This file is now OBSOLETE and no longer used ----------------  ---------------- This file is now OBSOLETE and no longer used ----------------
20  Builducptable    A Perl script that creates the contents of the ucptable.h file  Builducptable    A Perl script that creates the contents of the ucptable.h file
21                   from two Unicode data files, which themselves are downloaded                   from two Unicode data files, which themselves are downloaded
22                   from the Unicode web site. Run this script in the "maint"                   from the Unicode web site. Run this script in the "maint"
23                   directory.                   directory.
24  ----------------- This file is now OBSOLETE and no longer used ----------------  ---------------- This file is now OBSOLETE and no longer used ----------------
25    
26    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
28                     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.
# Line 32  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 40  Unicode.tables   The files in this direc Line 46  Unicode.tables   The files in this direc
46  ucptest.c        A short C program for testing the Unicode property macros  ucptest.c        A short C program for testing the Unicode property macros
47                   that do lookups in the pcre_ucd.c data, mainly useful after                   that do lookups in the pcre_ucd.c data, mainly useful after
48                   rebuilding the Unicode property table. Compile and run this in                   rebuilding the Unicode property table. Compile and run this in
49                   the "maint" directory.                   the "maint" directory (see comments at its head).
50    
51  ucptestdata      A directory containing two files, testinput1 and testoutput1,  ucptestdata      A directory containing two files, testinput1 and testoutput1,
52                   to use in conjunction with the ucptest program.                   to use in conjunction with the ucptest program.
# Line 55  utf8.c           A short, freestanding C Line 61  utf8.c           A short, freestanding C
61    
62    
63  Updating to a new Unicode release  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, and the MultiStage2.py script can then be run to  refreshed from the web site. If the new version of Unicode adds new character
68  generate a new version of pcre_ucd.c. The ucptest program can be used to check  scripts, the source file ucp.h and both the MultiStage2.py and the
69  that the resulting table works properly, using the data files in ucptestdata to  GenerateUtt.py scripts must be edited to add the new names. Then MultiStage2.py
70  check a number of test characters.  can be run to generate a new version of pcre_ucd.c, and GenerateUtt.py can be
71    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",
74    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
76    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
91  ----------------------------  ============================
92    
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 81  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 106  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. However, there is one exception: pcredemo.3,
139      which is created from the pcredemo.c program. It contains three instances
140      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 121  distribution for a new release. Line 147  distribution for a new release.
147    
148    
149  Making a PCRE release  Making a PCRE release
150  ---------------------  =====================
151    
152  Run PrepareRelease and commit the files that it changes (by removing trailing  Run PrepareRelease and commit the files that it changes (by removing trailing
153  spaces). Then run "make distcheck" to create the tarballs and the zipball.  spaces). Then run "make distcheck" to create the tarballs and the zipball.
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-7.x             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.  webmaster@pcre.org and the mailing list. Also, update the list of version
161    numbers in Bugzilla (edit products).
162    
163    
164  Future ideas (wish list)  Future ideas (wish list)
165  ------------------------  ========================
166    
167  This section records a list of ideas so that they do not get forgotten. They  This section records a list of ideas so that they do not get forgotten. They
168  vary enormously in their usefulness and potential for implementation. Some are  vary enormously in their usefulness and potential for implementation. Some are
# Line 156  others are relatively new. Line 183  others are relatively new.
183      to have little effect, and maybe makes things worse.      to have little effect, and maybe makes things worse.
184    
185    * "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
186      over the existing "required byte" (reqbyte) feature that just saves 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 study():
# Line 166  others are relatively new. Line 193  others are relatively new.
193      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
194        earlier one if common to all alternatives.        earlier one if common to all alternatives.
195    
     o Minimum length of subject needed.  
   
196      o Friedl contains other ideas.      o Friedl contains other ideas.
197    
198  . 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-
199    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
200    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE    difference is the matching of /(main(O)?)+/ against mainOmain, where PCRE
# Line 203  others are relatively new. Line 228  others are relatively new.
228    
229    * 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
230      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.
231      If this is done, a suitable option for pcregrep is also required.      If it is done, a suitable option for pcregrep is also required.
232    
233  . 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.
234    This probably affects quite a few places in the code.    This affects quite a few places in the code and is not trivial.
235    
236  . Catch SIGSEGV for stack overflows?  . Catch SIGSEGV for stack overflows?
237    
# Line 221  others are relatively new. Line 246  others are relatively new.
246    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)
247    support --outputfile=name.    support --outputfile=name.
248    
249  . 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.
250    
251  . 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
252    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 249  others are relatively new. Line 274  others are relatively new.
274    
275  . 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
276    Python, etc?    Python, etc?
277    
278    . A user suggested a parameter to limit the length of string matched, for
279      example if the parameter is N, the current match should fail if the matched
280      substring exceeds N. This could apply to both match functions. The value
281      could be a new field in the extra block.
282    
283    . Callouts with arguments: (?Cn:ARG) for instance.
284    
285    . A user is going to supply a patch to generalize the API for user-specific
286      memory allocation so that it is more flexible in threaded environments. This
287      was promised a long time ago, and never appeared...
288    
289    . Write a function that generates random matching strings for a compiled regex.
290    
291    . Write a wrapper to maintain a structure with specified runtime parameters,
292      such as recurse limit, and pass these to PCRE each time it is called. Also
293      maybe malloc and free. A user sent a prototype.
294    
295    . Pcregrep: an option to specify the output line separator, either as a string
296      or select from a fixed list. This is not dead easy, because at the moment it
297      outputs whatever is in the input file.
298    
299    . Improve the code for duplicate checking in pcre_dfa_exec(). An incomplete,
300      non-thread-safe patch showed that this can help performance for patterns
301      where there are many alternatives. However, a simple thread-safe
302      implementation that I tried made things worse in many simple cases, so this
303      is not an obviously good thing.
304    
305    . Make the longest lookbehind available via pcre_fullinfo(). This is not
306      straightforward because lookbehinds can be nested inside lookbehinds. This
307      case will have to be identified, and the amounts added. This should then give
308      the maximum possible lookbehind length. The reason for wanting this is to
309      help when implementing multi-segment matching using pcre_exec() with partial
310      matching and overlapping segments.
311    
312    . PCRE cannot at present distinguish between subpatterns with different names,
313      but the same number (created by the use of ?|). In order to do so, a way of
314      remembering *which* subpattern numbered n matched is needed. Bugzilla #760.
315    
316    . Instead of having #ifdef HAVE_CONFIG_H in each module, put #include
317      "something" and the the #ifdef appears only in one place, in "something".
318    
319    . Support for (*MARK) and arguments for (*PRUNE) and friends.
320    
321  Philip Hazel  Philip Hazel
322  Email local part: ph10  Email local part: ph10
323  Email domain: cam.ac.uk  Email domain: cam.ac.uk
324  Last updated: 02 July 2008  Last updated: 10 March 2010

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

  ViewVC Help
Powered by ViewVC 1.1.5