/[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 733 by ph10, Tue Oct 11 10:29:36 2011 UTC revision 984 by ph10, Fri Jul 6 09:58:13 2012 UTC
# 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. The relevant files are CMakeLists.txt    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    and config-cmake.h.in. After making a release tarball, test it out with CMake
# Line 115  distribution for a new release. Line 118  distribution for a new release.
118    different configurations, and it also runs some of them with valgrind, all of    different configurations, and it also runs some of them with valgrind, all of
119    which can take quite some time.    which can take quite some time.
120    
121  . Run perltest.pl on the test data for tests 1, 4, 6, 11, and 12. The output  . 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    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    the start of each test. The other tests are not Perl-compatible (they use
124    various PCRE-specific features or options).    various PCRE-specific features or options).
# Line 125  distribution for a new release. Line 128  distribution for a new release.
128    may see a number of "pcre_memmove defined but not used" warnings for the    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.    modules in which there is no call to memmove(). These can be ignored.
130    
131  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
132    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.    NEWS (check version and date), NON-AUTOTOOLS-BUILD, and README. Many of these
133    Many of these won't need changing, but over the long term things do change.    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  . 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    systems, using different compilers as well. For example, on Solaris it is
# Line 136  distribution for a new release. Line 139  distribution for a new release.
139    pcretest to increase the stack size for test 2. Since I retired I can no    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    longer do this, but instead I rely on putting out release candidates for
141    folks on the pcre-dev list to test.    folks on the pcre-dev list to test.
142    
143    
144    Updating version info for libtool
145    =================================
146    
147    This set of rules for updating library version information came from a web page
148    whose URL I have forgotten. The version information consists of three parts:
149    (current, revision, age).
150    
151    1. Start with version information of 0:0:0 for each libtool library.
152    
153    2. Update the version information only immediately before a public release of
154       your software. More frequent updates are unnecessary, and only guarantee
155       that the current interface number gets larger faster.
156    
157    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    4. If any interfaces have been added, removed, or changed since the last
161       update, increment current, and set revision to 0.
162    
163    5. If any interfaces have been added since the last public release, then
164       increment age.
165    
166    6. If any interfaces have been removed or changed since the last public
167       release, then set age to 0.
168    
169    The following explanation may help in understanding the above rules a bit
170    better. Consider that there are three possible kinds of reaction from users to
171    changes in a shared library:
172    
173    1. Programs using the previous version may use the new version as a drop-in
174       replacement, and programs using the new version can also work with the
175       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    2. Programs using the previous version may use the new version as a drop-in
179       replacement, but programs using the new version may use APIs not present in
180       the previous one. In other words, a program linking against the new version
181       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    3. Programs may need to be changed, recompiled, relinked in order to use the
185       new version. Increment current, set revision and age to 0.
186    
187    
188  Making a PCRE release  Making a PCRE release
# Line 180  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 206  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  
   
   * There has been a request for direct support of 16-bit characters and  
     UTF-16 (Bugzilla #1049). 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. Another possibility is to provide a set of  
     translation functions, and build an index during translation so that the  
     returned offsets can automatically be translated (using the index) after a  
     match.  
   
   * 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? I  
     suspect not.  
   
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 250  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 264  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 287  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 324  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: 11 October 2011  Last updated: 18 June 2012

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

  ViewVC Help
Powered by ViewVC 1.1.5