/[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 654 by ph10, Tue Aug 2 11:00:40 2011 UTC revision 1217 by ph10, Fri Nov 9 17:07:01 2012 UTC
# Line 44  pcre_chartables.c.non-standard Line 44  pcre_chartables.c.non-standard
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. The relevant files are CMakeLists.txt    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    and config-cmake.h.in. After making a release tarball, test it out with CMake
# Line 109  distribution for a new release. Line 113  distribution for a new release.
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, 6, 11, and 12. The output  . 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    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    the start of each test. The other tests are not Perl-compatible (they use
125    various PCRE-specific features or options).    various PCRE-specific features or options).
126    
 . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest  
   valgrind", though that takes quite a long time.  
   
127  . It is possible to test with the emulated memmove() function by undefining  . 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    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    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.    modules in which there is no call to memmove(). These can be ignored.
131    
132  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
133    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
134    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.
135    
136  . 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
137    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 135  distribution for a new release. Line 140  distribution for a new release.
140    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
141    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
142    folks on the pcre-dev list to test.    folks on the pcre-dev list to test.
143    
144    
145    Updating version info for libtool
146    =================================
147    
148    This set of rules for updating library version information came from a web page
149    whose URL I have forgotten. The version information consists of three parts:
150    (current, revision, age).
151    
152    1. Start with version information of 0:0:0 for each libtool library.
153    
154    2. Update the version information only immediately before a public release of
155       your software. More frequent updates are unnecessary, and only guarantee
156       that the current interface number gets larger faster.
157    
158    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    4. If any interfaces have been added, removed, or changed since the last
162       update, increment current, and set revision to 0.
163    
164    5. If any interfaces have been added since the last public release, then
165       increment age.
166    
167    6. If any interfaces have been removed or changed since the last public
168       release, then set age to 0.
169    
170    The following explanation may help in understanding the above rules a bit
171    better. Consider that there are three possible kinds of reaction from users to
172    changes in a shared library:
173    
174    1. Programs using the previous version may use the new version as a drop-in
175       replacement, and programs using the new version can also work with the
176       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    2. Programs using the previous version may use the new version as a drop-in
180       replacement, but programs using the new version may use APIs not present in
181       the previous one. In other words, a program linking against the new version
182       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    3. Programs may need to be changed, recompiled, relinked in order to use the
186       new version. Increment current, set revision and age to 0.
187    
188    
189  Making a PCRE release  Making a PCRE release
# Line 179  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 205  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  
   
   * 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.  
   
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 249  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, and UTF-32 and UCP
283      for the 32-bit library.)
284    
285  . 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
286    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 263  others are relatively new. Line 295  others are relatively new.
295  . 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
296    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
297    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.
298      This is probably obsolete now that we have the JIT support.
299    
300  . Should pcretest have some private locale data, to avoid relying on the  . Should pcretest have some private locale data, to avoid relying on the
301    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 286  others are relatively new. Line 319  others are relatively new.
319    
320  . 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
321    memory allocation so that it is more flexible in threaded environments. This    memory allocation so that it is more flexible in threaded environments. This
322    was promised a long time ago, and never appeared...    was promised a long time ago, and never appeared. However, this is a live
323      issue not only for threaded environments, but for libraries that use PCRE and
324  . Write a function that generates random matching strings for a compiled regex.    want not to be beholden to their caller's memory allocation.
325    
326  . Write a wrapper to maintain a structure with specified runtime parameters,  . Write a wrapper to maintain a structure with specified runtime parameters,
327    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
328    maybe malloc and free. A user sent a prototype.    maybe malloc and free. A user sent a prototype. This relates the the previous
329      item.
330    
331    . Write a function that generates random matching strings for a compiled regex.
332    
333  . 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
334    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 304  others are relatively new. Line 340  others are relatively new.
340    implementation that I tried made things worse in many simple cases, so this    implementation that I tried made things worse in many simple cases, so this
341    is not an obviously good thing.    is not an obviously good thing.
342    
 . Make the longest lookbehind available via pcre_fullinfo(). This is not  
   straightforward because lookbehinds can be nested inside lookbehinds. This  
   case will have to be identified, and the amounts added. This should then give  
   the maximum possible lookbehind length. The reason for wanting this is to  
   help when implementing multi-segment matching using pcre_exec() with partial  
   matching and overlapping segments.  
   
343  . PCRE cannot at present distinguish between subpatterns with different names,  . PCRE cannot at present distinguish between subpatterns with different names,
344    but the same number (created by the use of ?|). In order to do so, a way of    but the same number (created by the use of ?|). In order to do so, a way of
345    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.
# Line 323  others are relatively new. Line 352  others are relatively new.
352  Philip Hazel  Philip Hazel
353  Email local part: ph10  Email local part: ph10
354  Email domain: cam.ac.uk  Email domain: cam.ac.uk
355  Last updated: 02 August 2011  Last updated: 09 November 2012

Legend:
Removed from v.654  
changed lines
  Added in v.1217

  ViewVC Help
Powered by ViewVC 1.1.5