/[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 539 by ph10, Sun Jun 13 21:35:04 2010 UTC revision 1044 by ph10, Thu Sep 20 16:23:57 2012 UTC
# Line 35  MultiStage2.py   A Python script that ge Line 35  MultiStage2.py   A Python script that ge
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  pcre_chartables.c.non-standard  pcre_chartables.c.non-standard
40                   This is a set of character tables that came from a Windows                   This is a set of character tables that came from a Windows
41                   system. It has characters greater than 128 that are set as                   system. It has characters greater than 128 that are set as
42                   spaces, amongst other things. I kept it so that it can be                   spaces, amongst other things. I kept it so that it can be
43                   used for testing from time to time.                   used for testing from time to time.
44    
45  README           This file.  README           This file.
46    
47  Unicode.tables   The files in this directory, DerivedGeneralCategory.txt,  Unicode.tables   The files in this directory (CaseFolding.txt,
48                   Scripts.txt and UnicodeData.txt, were downloaded from the                   DerivedGeneralCategory.txt, GraphemeBreakProperty.txt,
49                     Scripts.txt and UnicodeData.txt) were downloaded from the
50                   Unicode web site. They contain information about Unicode                   Unicode web site. They contain information about Unicode
51                   characters and scripts.                   characters and scripts.
52    
53  ucptest.c        A short C program for testing the Unicode property macros  ucptest.c        A short C program for testing the Unicode property macros
54                   that do lookups in the pcre_ucd.c data, mainly useful after                   that do lookups in the pcre_ucd.c data, mainly useful after
# Line 101  distribution for a new release. Line 102  distribution for a new release.
102    
103  . 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.
104    
105    . Update the library version numbers in configure.ac according to the rules
106      given below.
107    
108  . 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
109    files as well as to the autoconf files.    files as well as to the autoconf files. The relevant files are CMakeLists.txt
110      and config-cmake.h.in. After making a release tarball, test it out with CMake
111      if there have been changes here.
112    
113  . Run ./autogen.sh to ensure everything is up-to-date.  . Run ./autogen.sh to ensure everything is up-to-date.
114    
115  . Compile and test with many different config options, and combinations of  . Compile and test with many different config options, and combinations of
116    options. The maint/ManyConfigTests script now encapsulates this testing.    options. Also, test with valgrind by running "RunTest valgrind" and
117      "RunGrepTest valgrind" (which takes quite a long time). The script
118      maint/ManyConfigTests now encapsulates this testing. It runs tests with
119      different configurations, and it also runs some of them with valgrind, all of
120      which can take quite some time.
121    
122    . Run perltest.pl on the test data for tests 1, 4, and 6. The output
123      should match the PCRE test output, apart from the version identification at
124      the start of each test. The other tests are not Perl-compatible (they use
125      various PCRE-specific features or options).
126    
127    . It is possible to test with the emulated memmove() function by undefining
128      HAVE_MEMMOVE and HAVE_BCOPY in config.h, though I do not do this often. You
129      may see a number of "pcre_memmove defined but not used" warnings for the
130      modules in which there is no call to memmove(). These can be ignored.
131    
132    . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
133      NEWS (check version and date), NON-AUTOTOOLS-BUILD, and README. Many of these
134      won't need changing, but over the long term things do change.
135    
136    . I used to test new releases myself on a number of different operating
137      systems, using different compilers as well. For example, on Solaris it is
138      helpful to test using Sun's cc compiler as a change from gcc. Adding
139      -xarch=v9 to the cc options does a 64-bit test, but it also needs -S 64 for
140      pcretest to increase the stack size for test 2. Since I retired I can no
141      longer do this, but instead I rely on putting out release candidates for
142      folks on the pcre-dev list to test.
143    
144    
145    Updating version info for libtool
146    =================================
147    
148  . Run perltest.pl on the test data for tests 1, 4, 6, and 11. The first two can  This set of rules for updating library version information came from a web page
149    be run with Perl 5.8 or >= 5.10; the last two require Perl >= 5.10. The  whose URL I have forgotten. The version information consists of three parts:
150    output should match the PCRE test output, apart from the version  (current, revision, age).
   identification at the start of each test. The other tests are not  
   Perl-compatible (they use various PCRE-specific features or options).  
151    
152  . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest  1. Start with version information of 0:0:0 for each libtool library.
   valgrind", though that takes quite a long time.  
153    
154  . It may also useful to test with Electric Fence, though the fact that it  2. Update the version information only immediately before a public release of
155    grumbles for missing free() calls can be a nuisance. (A missing free() in     your software. More frequent updates are unnecessary, and only guarantee
156    pcretest is hardly a big problem.) To build with EF, use:     that the current interface number gets larger faster.
157    
158      LIBS='/usr/lib/libefence.a -lpthread' with ./configure.  3. If the library source code has changed at all since the last update, then
159       increment revision; c:r:a becomes c:r+1:a.
160    
161    Then all normal runs use it to check for buffer overflow. Also run everything  4. If any interfaces have been added, removed, or changed since the last
162    with:     update, increment current, and set revision to 0.
163    
164      EF_PROTECT_BELOW=1 <whatever>  5. If any interfaces have been added since the last public release, then
165       increment age.
166    
167    because there have been problems with lookbehinds that looked too far.  6. If any interfaces have been removed or changed since the last public
168       release, then set age to 0.
169    
170  . Test with the emulated memmove() function by undefining HAVE_MEMMOVE and  The following explanation may help in understanding the above rules a bit
171    HAVE_BCOPY in config.h. You may see a number of "pcre_memmove defined but not  better. Consider that there are three possible kinds of reaction from users to
172    used" warnings for the modules in which there is no call to memmove(). These  changes in a shared library:
   can be ignored.  
173    
174  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  1. Programs using the previous version may use the new version as a drop-in
175    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.     replacement, and programs using the new version can also work with the
176    Many of these won't need changing, but over the long term things do change.     previous one. In other words, no recompiling nor relinking is needed. In
177       this case, increment revision only, don't touch current or age.
178    
179  . Man pages: Check all man pages for \ not followed by e or f or " because  2. Programs using the previous version may use the new version as a drop-in
180    that indicates a markup error. However, there is one exception: pcredemo.3,     replacement, but programs using the new version may use APIs not present in
181    which is created from the pcredemo.c program. It contains three instances     the previous one. In other words, a program linking against the new version
182    of \\n.     may fail if linked against the old version at run time. In this case, set
183       revision to 0, increment current and age.
184    
185  . When the release is built, test it on a number of different operating  3. Programs may need to be changed, recompiled, relinked in order to use the
186    systems if possible, and using different compilers as well. For example,     new version. Increment current, set revision and age to 0.
   on Solaris it is helpful to test using Sun's cc compiler as a change from  
   gcc. Adding -xarch=v9 to the cc options does a 64-bit test, but it also  
   needs -S 64 for pcretest to increase the stack size for test 2.  
187    
188    
189  Making a PCRE release  Making a PCRE release
190  =====================  =====================
191    
192  Run PrepareRelease and commit the files that it changes (by removing trailing  Run PrepareRelease and commit the files that it changes (by removing trailing
193  spaces). Then run "make distcheck" to create the tarballs and the zipball.  spaces). The first thing this script does is to run CheckMan on the man pages;
194  Double-check with "svn status", then create an SVN tagged copy:  if it finds any markup errors, it reports them and then aborts.
195    
196    Once PrepareRelease has run clean, run "make distcheck" to create the tarballs
197    and the zipball. Double-check with "svn status", then create an SVN tagged
198    copy:
199    
200    svn copy svn://vcs.exim.org/pcre/code/trunk \    svn copy svn://vcs.exim.org/pcre/code/trunk \
201             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx
# Line 190  others are relatively new. Line 228  others are relatively new.
228    
229    * "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
230      over the existing "required byte" (reqbyte) feature that just remembers one      over the existing "required byte" (reqbyte) feature that just remembers one
231      byte.      data unit.
232    
233    * These probably need to go in pcre_study():    * These probably need to go in pcre_study():
234    
235      o Remember an initial string rather than just 1 char?      o Remember an initial string rather than just 1 char?
236    
237      o A required byte from alternatives - not just the last char, but an      o A required data unit from alternatives - not just the last unit, but an
238        earlier one if common to all alternatives.        earlier one if common to all alternatives.
239    
240      o Friedl contains other ideas.      o Friedl contains other ideas.
# Line 216  others are relatively new. Line 254  others are relatively new.
254    
255  . Perl 6 will be a revolution. Is it a revolution too far for PCRE?  . Perl 6 will be a revolution. Is it a revolution too far for PCRE?
256    
 . Unicode  
   
   * A different approach to Unicode might be to use a typedef to do everything  
     in unsigned shorts instead of unsigned chars. Actually, we'd have to have a  
     new typedef to distinguish data from bits of compiled pattern that are in  
     bytes, I think. There would need to be conversion functions in and out. I  
     don't think this is particularly trivial - and anyway, Unicode now has  
     characters that need more than 16 bits, so is this at all sensible?  
   
   * There has been a request for direct support of 16-bit characters and  
     UTF-16. However, since Unicode is moving beyond purely 16-bit characters,  
     is this worth it at all? One possible way of handling 16-bit characters  
     would be to "load" them in the same way that UTF-8 characters are loaded.  
   
257  . Allow errorptr and erroroffset to be NULL. I don't like this idea.  . Allow errorptr and erroroffset to be NULL. I don't like this idea.
258    
259  . Line endings:  . Line endings:
# Line 255  others are relatively new. Line 279  others are relatively new.
279    support --outputfile=name.    support --outputfile=name.
280    
281  . Consider making UTF-8 and UCP the default for PCRE n.0 for some n > 8.  . Consider making UTF-8 and UCP the default for PCRE n.0 for some n > 8.
282      (And now presumably UTF-16 and UCP for the 16-bit library.)
283    
284  . 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
285    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 269  others are relatively new. Line 294  others are relatively new.
294  . Wild thought: the ability to compile from PCRE's internal byte code to a real  . Wild thought: the ability to compile from PCRE's internal byte code to a real
295    FSM and a very fast (third) matcher to process the result. There would be    FSM and a very fast (third) matcher to process the result. There would be
296    even more restrictions than for pcre_dfa_exec(), however. This is not easy.    even more restrictions than for pcre_dfa_exec(), however. This is not easy.
297      This is probably obsolete now that we have the JIT support.
298    
299  . Should pcretest have some private locale data, to avoid relying on the  . Should pcretest have some private locale data, to avoid relying on the
300    available locales for the test data, since different OS have different ideas?    available locales for the test data, since different OS have different ideas?
# Line 292  others are relatively new. Line 318  others are relatively new.
318    
319  . 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
320    memory allocation so that it is more flexible in threaded environments. This    memory allocation so that it is more flexible in threaded environments. This
321    was promised a long time ago, and never appeared...    was promised a long time ago, and never appeared. However, this is a live
322      issue not only for threaded environments, but for libraries that use PCRE and
323  . Write a function that generates random matching strings for a compiled regex.    want not to be beholden to their caller's memory allocation.
324    
325  . Write a wrapper to maintain a structure with specified runtime parameters,  . Write a wrapper to maintain a structure with specified runtime parameters,
326    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
327    maybe malloc and free. A user sent a prototype.    maybe malloc and free. A user sent a prototype. This relates the the previous
328      item.
329    
330    . Write a function that generates random matching strings for a compiled regex.
331    
332  . 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
333    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
# Line 329  others are relatively new. Line 358  others are relatively new.
358  Philip Hazel  Philip Hazel
359  Email local part: ph10  Email local part: ph10
360  Email domain: cam.ac.uk  Email domain: cam.ac.uk
361  Last updated: 03 June 2010  Last updated: 20 September 2012

Legend:
Removed from v.539  
changed lines
  Added in v.1044

  ViewVC Help
Powered by ViewVC 1.1.5