/[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 984 by ph10, Fri Jul 6 09:58:13 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    
# Line 101  distribution for a new release. Line 101  distribution for a new release.
101    
102  . 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.
103    
104    . Update the library version numbers in configure.ac according to the rules
105      given below.
106    
107  . 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
108    files as well as to the autoconf files.    files as well as to the autoconf files. The relevant files are CMakeLists.txt
109      and config-cmake.h.in. After making a release tarball, test it out with CMake
110      if there have been changes here.
111    
112  . Run ./autogen.sh to ensure everything is up-to-date.  . Run ./autogen.sh to ensure everything is up-to-date.
113    
114  . Compile and test with many different config options, and combinations of  . Compile and test with many different config options, and combinations of
115    options. The maint/ManyConfigTests script now encapsulates this testing.    options. Also, test with valgrind by running "RunTest valgrind" and
116      "RunGrepTest valgrind" (which takes quite a long time). The script
117      maint/ManyConfigTests now encapsulates this testing. It runs tests with
118      different configurations, and it also runs some of them with valgrind, all of
119      which can take quite some time.
120    
121    . Run perltest.pl on the test data for tests 1, 4, and 6. The output
122      should match the PCRE test output, apart from the version identification at
123      the start of each test. The other tests are not Perl-compatible (they use
124      various PCRE-specific features or options).
125    
126    . It is possible to test with the emulated memmove() function by undefining
127      HAVE_MEMMOVE and HAVE_BCOPY in config.h, though I do not do this often. You
128      may see a number of "pcre_memmove defined but not used" warnings for the
129      modules in which there is no call to memmove(). These can be ignored.
130    
131    . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
132      NEWS (check version and date), NON-AUTOTOOLS-BUILD, and README. Many of these
133      won't need changing, but over the long term things do change.
134    
135    . I used to test new releases myself on a number of different operating
136      systems, using different compilers as well. For example, on Solaris it is
137      helpful to test using Sun's cc compiler as a change from gcc. Adding
138      -xarch=v9 to the cc options does a 64-bit test, but it also needs -S 64 for
139      pcretest to increase the stack size for test 2. Since I retired I can no
140      longer do this, but instead I rely on putting out release candidates for
141      folks on the pcre-dev list to test.
142    
143    
144    Updating version info for libtool
145    =================================
146    
147  . 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
148    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:
149    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).  
150    
151  . 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.  
152    
153  . 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
154    grumbles for missing free() calls can be a nuisance. (A missing free() in     your software. More frequent updates are unnecessary, and only guarantee
155    pcretest is hardly a big problem.) To build with EF, use:     that the current interface number gets larger faster.
156    
157      LIBS='/usr/lib/libefence.a -lpthread' with ./configure.  3. If the library source code has changed at all since the last update, then
158       increment revision; c:r:a becomes c:r+1:a.
159    
160    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
161    with:     update, increment current, and set revision to 0.
162    
163      EF_PROTECT_BELOW=1 <whatever>  5. If any interfaces have been added since the last public release, then
164       increment age.
165    
166    because there have been problems with lookbehinds that looked too far.  6. If any interfaces have been removed or changed since the last public
167       release, then set age to 0.
168    
169  . Test with the emulated memmove() function by undefining HAVE_MEMMOVE and  The following explanation may help in understanding the above rules a bit
170    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
171    used" warnings for the modules in which there is no call to memmove(). These  changes in a shared library:
   can be ignored.  
172    
173  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  1. Programs using the previous version may use the new version as a drop-in
174    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.     replacement, and programs using the new version can also work with the
175    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
176       this case, increment revision only, don't touch current or age.
177    
178  . 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
179    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
180    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
181    of \\n.     may fail if linked against the old version at run time. In this case, set
182       revision to 0, increment current and age.
183    
184  . 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
185    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.  
186    
187    
188  Making a PCRE release  Making a PCRE release
189  =====================  =====================
190    
191  Run PrepareRelease and commit the files that it changes (by removing trailing  Run PrepareRelease and commit the files that it changes (by removing trailing
192  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;
193  Double-check with "svn status", then create an SVN tagged copy:  if it finds any markup errors, it reports them and then aborts.
194    
195    Once PrepareRelease has run clean, run "make distcheck" to create the tarballs
196    and the zipball. Double-check with "svn status", then create an SVN tagged
197    copy:
198    
199    svn copy svn://vcs.exim.org/pcre/code/trunk \    svn copy svn://vcs.exim.org/pcre/code/trunk \
200             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 227  others are relatively new.
227    
228    * "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
229      over the existing "required byte" (reqbyte) feature that just remembers one      over the existing "required byte" (reqbyte) feature that just remembers one
230      byte.      data unit.
231    
232    * These probably need to go in pcre_study():    * These probably need to go in pcre_study():
233    
234      o Remember an initial string rather than just 1 char?      o Remember an initial string rather than just 1 char?
235    
236      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
237        earlier one if common to all alternatives.        earlier one if common to all alternatives.
238    
239      o Friedl contains other ideas.      o Friedl contains other ideas.
# Line 216  others are relatively new. Line 253  others are relatively new.
253    
254  . 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?
255    
 . 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.  
   
256  . 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.
257    
258  . Line endings:  . Line endings:
# Line 255  others are relatively new. Line 278  others are relatively new.
278    support --outputfile=name.    support --outputfile=name.
279    
280  . 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.
281      (And now presumably UTF-16 and UCP for the 16-bit library.)
282    
283  . 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
284    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 269  others are relatively new. Line 293  others are relatively new.
293  . 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
294    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
295    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.
296      This is probably obsolete now that we have the JIT support.
297    
298  . Should pcretest have some private locale data, to avoid relying on the  . Should pcretest have some private locale data, to avoid relying on the
299    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 317  others are relatively new.
317    
318  . 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
319    memory allocation so that it is more flexible in threaded environments. This    memory allocation so that it is more flexible in threaded environments. This
320    was promised a long time ago, and never appeared...    was promised a long time ago, and never appeared. However, this is a live
321      issue not only for threaded environments, but for libraries that use PCRE and
322  . Write a function that generates random matching strings for a compiled regex.    want not to be beholden to their caller's memory allocation.
323    
324  . Write a wrapper to maintain a structure with specified runtime parameters,  . Write a wrapper to maintain a structure with specified runtime parameters,
325    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
326    maybe malloc and free. A user sent a prototype.    maybe malloc and free. A user sent a prototype. This relates the the previous
327      item.
328    
329    . Write a function that generates random matching strings for a compiled regex.
330    
331  . 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
332    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 357  others are relatively new.
357  Philip Hazel  Philip Hazel
358  Email local part: ph10  Email local part: ph10
359  Email domain: cam.ac.uk  Email domain: cam.ac.uk
360  Last updated: 03 June 2010  Last updated: 18 June 2012

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

  ViewVC Help
Powered by ViewVC 1.1.5