/[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 579 by ph10, Wed Nov 24 17:39:25 2010 UTC revision 1232 by ph10, Fri Dec 7 12:08:44 2012 UTC
# Line 16  also contains some notes for maintainers Line 16  also contains some notes for maintainers
16  Files in the maint directory  Files in the maint directory
17  ============================  ============================
18    
 ---------------- This file is now OBSOLETE and no longer used ----------------  
 Builducptable    A Perl script that creates the contents of the ucptable.h file  
                  from two Unicode data files, which themselves are downloaded  
                  from the Unicode web site. Run this script in the "maint"  
                  directory.  
 ---------------- This file is now OBSOLETE and no longer used ----------------  
   
19  GenerateUtt.py   A Python script to generate part of the pcre_tables.c file  GenerateUtt.py   A Python script to generate part of the pcre_tables.c file
20                   that contains Unicode script names in a long string with                   that contains Unicode script names in a long string with
21                   offsets, which is tedious to maintain by hand.                   offsets, which is tedious to maintain by hand.
# Line 35  MultiStage2.py   A Python script that ge Line 28  MultiStage2.py   A Python script that ge
28                   Unicode web site. Run this script in the "maint" directory.                   Unicode web site. Run this script in the "maint" directory.
29                   The generated file contains the tables for a 2-stage lookup                   The generated file contains the tables for a 2-stage lookup
30                   of Unicode properties.                   of Unicode properties.
31    
32  pcre_chartables.c.non-standard  pcre_chartables.c.non-standard
33                   This is a set of character tables that came from a Windows                   This is a set of character tables that came from a Windows
34                   system. It has characters greater than 128 that are set as                   system. It has characters greater than 128 that are set as
35                   spaces, amongst other things. I kept it so that it can be                   spaces, amongst other things. I kept it so that it can be
36                   used for testing from time to time.                   used for testing from time to time.
37    
38  README           This file.  README           This file.
39    
40  Unicode.tables   The files in this directory, DerivedGeneralCategory.txt,  Unicode.tables   The files in this directory (CaseFolding.txt,
41                   Scripts.txt and UnicodeData.txt, were downloaded from the                   DerivedGeneralCategory.txt, GraphemeBreakProperty.txt,
42                     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
44                   characters and scripts.                   characters and scripts.
45    
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
# Line 101  distribution for a new release. Line 95  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.
97    
98    . Update the library version numbers in configure.ac according to the rules
99      given below.
100    
101  . 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
102    files as well as to the autoconf files.    files as well as to the autoconf files. The relevant files are CMakeLists.txt
103      and config-cmake.h.in. After making a release tarball, test it out with CMake
104      if there have been changes here.
105    
106  . Run ./autogen.sh to ensure everything is up-to-date.  . Run ./autogen.sh to ensure everything is up-to-date.
107    
108  . Compile and test with many different config options, and combinations of  . Compile and test with many different config options, and combinations of
109    options. The maint/ManyConfigTests script now encapsulates this testing.    options. Also, test with valgrind by running "RunTest valgrind" and
110      "RunGrepTest valgrind" (which takes quite a long time). The script
111      maint/ManyConfigTests now encapsulates this testing. It runs tests with
112      different configurations, and it also runs some of them with valgrind, all of
113      which can take quite some time.
114    
115    . Run perltest.pl on the test data for tests 1, 4, and 6. The output
116      should match the PCRE test output, apart from the version identification at
117      the start of each test. The other tests are not Perl-compatible (they use
118      various PCRE-specific features or options).
119    
120    . It is possible to test with the emulated memmove() function by undefining
121      HAVE_MEMMOVE and HAVE_BCOPY in config.h, though I do not do this often. You
122      may see a number of "pcre_memmove defined but not used" warnings for the
123      modules in which there is no call to memmove(). These can be ignored.
124    
125    . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
126      NEWS (check version and date), NON-AUTOTOOLS-BUILD, and README. Many of these
127      won't need changing, but over the long term things do change.
128    
129    . I used to test new releases myself on a number of different operating
130      systems, using different compilers as well. For example, on Solaris it is
131      helpful to test using Sun's cc compiler as a change from gcc. Adding
132      -xarch=v9 to the cc options does a 64-bit test, but it also needs -S 64 for
133      pcretest to increase the stack size for test 2. Since I retired I can no
134      longer do this, but instead I rely on putting out release candidates for
135      folks on the pcre-dev list to test.
136    
137    
138    Updating version info for libtool
139    =================================
140    
141    This set of rules for updating library version information came from a web page
142    whose URL I have forgotten. The version information consists of three parts:
143    (current, revision, age).
144    
145    1. Start with version information of 0:0:0 for each libtool library.
146    
147    2. Update the version information only immediately before a public release of
148       your software. More frequent updates are unnecessary, and only guarantee
149       that the current interface number gets larger faster.
150    
151    3. If the library source code has changed at all since the last update, then
152       increment revision; c:r:a becomes c:r+1:a.
153    
154    4. If any interfaces have been added, removed, or changed since the last
155       update, increment current, and set revision to 0.
156    
157    5. If any interfaces have been added since the last public release, then
158       increment age.
159    
160    6. If any interfaces have been removed or changed since the last public
161       release, then set age to 0.
162    
163  . Run perltest.pl on the test data for tests 1, 4, 6, and 11. The output should  The following explanation may help in understanding the above rules a bit
164    match the PCRE test output, apart from the version identification at the  better. Consider that there are three possible kinds of reaction from users to
165    start of each test. The other tests are not Perl-compatible (they use various  changes in a shared library:
166    PCRE-specific features or options).  
167    1. Programs using the previous version may use the new version as a drop-in
168  . Test with valgrind by running "RunTest valgrind". There is also "RunGrepTest     replacement, and programs using the new version can also work with the
169    valgrind", though that takes quite a long time.     previous one. In other words, no recompiling nor relinking is needed. In
170       this case, increment revision only, don't touch current or age.
171  . Test with the emulated memmove() function by undefining HAVE_MEMMOVE and  
172    HAVE_BCOPY in config.h. You may see a number of "pcre_memmove defined but not  2. Programs using the previous version may use the new version as a drop-in
173    used" warnings for the modules in which there is no call to memmove(). These     replacement, but programs using the new version may use APIs not present in
174    can be ignored.     the previous one. In other words, a program linking against the new version
175       may fail if linked against the old version at run time. In this case, set
176  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),     revision to 0, increment current and age.
177    INSTALL, LICENCE, NEWS (check version and date), NON-UNIX-USE, and README.  
178    Many of these won't need changing, but over the long term things do change.  3. Programs may need to be changed, recompiled, relinked in order to use the
179       new version. Increment current, set revision and age to 0.
 . Man pages: Check all man pages for \ not followed by e or f or " because  
   that indicates a markup error. However, there is one exception: pcredemo.3,  
   which is created from the pcredemo.c program. It contains three instances  
   of \\n.  
   
 . When the release is built, test it on a number of different operating  
   systems if possible, and using different compilers as well. For example,  
   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.  
180    
181    
182  Making a PCRE release  Making a PCRE release
183  =====================  =====================
184    
185  Run PrepareRelease and commit the files that it changes (by removing trailing  Run PrepareRelease and commit the files that it changes (by removing trailing
186  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;
187  Double-check with "svn status", then create an SVN tagged copy:  if it finds any markup errors, it reports them and then aborts.
188    
189    Once PrepareRelease has run clean, run "make distcheck" to create the tarballs
190    and the zipball. Double-check with "svn status", then create an SVN tagged
191    copy:
192    
193    svn copy svn://vcs.exim.org/pcre/code/trunk \    svn copy svn://vcs.exim.org/pcre/code/trunk \
194             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx             svn://vcs.exim.org/pcre/code/tags/pcre-8.xx
# Line 176  others are relatively new. Line 221  others are relatively new.
221    
222    * "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
223      over the existing "required byte" (reqbyte) feature that just remembers one      over the existing "required byte" (reqbyte) feature that just remembers one
224      byte.      data unit.
225    
226    * These probably need to go in pcre_study():    * These probably need to go in pcre_study():
227    
228      o Remember an initial string rather than just 1 char?      o Remember an initial string rather than just 1 char?
229    
230      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
231        earlier one if common to all alternatives.        earlier one if common to all alternatives.
232    
233      o Friedl contains other ideas.      o Friedl contains other ideas.
# Line 202  others are relatively new. Line 247  others are relatively new.
247    
248  . 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?
249    
 . 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.  
   
250  . 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.
251    
252  . Line endings:  . Line endings:
# Line 241  others are relatively new. Line 272  others are relatively new.
272    support --outputfile=name.    support --outputfile=name.
273    
274  . 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.
275      (And now presumably UTF-16 and UCP for the 16-bit library, and UTF-32 and UCP
276      for the 32-bit library.)
277    
278  . 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
279    needed to retain backward compatibility.    needed to retain backward compatibility.
# Line 255  others are relatively new. Line 288  others are relatively new.
288  . 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
289    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
290    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.
291      This is probably obsolete now that we have the JIT support.
292    
293  . Should pcretest have some private locale data, to avoid relying on the  . Should pcretest have some private locale data, to avoid relying on the
294    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 278  others are relatively new. Line 312  others are relatively new.
312    
313  . 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
314    memory allocation so that it is more flexible in threaded environments. This    memory allocation so that it is more flexible in threaded environments. This
315    was promised a long time ago, and never appeared...    was promised a long time ago, and never appeared. However, this is a live
316      issue not only for threaded environments, but for libraries that use PCRE and
317  . Write a function that generates random matching strings for a compiled regex.    want not to be beholden to their caller's memory allocation.
318    
319  . Write a wrapper to maintain a structure with specified runtime parameters,  . Write a wrapper to maintain a structure with specified runtime parameters,
320    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
321    maybe malloc and free. A user sent a prototype.    maybe malloc and free. A user sent a prototype. This relates the the previous
322      item.
323    
324    . Write a function that generates random matching strings for a compiled regex.
325    
326  . 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
327    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 296  others are relatively new. Line 333  others are relatively new.
333    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
334    is not an obviously good thing.    is not an obviously good thing.
335    
 . 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.  
   
336  . PCRE cannot at present distinguish between subpatterns with different names,  . PCRE cannot at present distinguish between subpatterns with different names,
337    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
338    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.    remembering *which* subpattern numbered n matched is needed. Bugzilla #760.
# Line 315  others are relatively new. Line 345  others are relatively new.
345  Philip Hazel  Philip Hazel
346  Email local part: ph10  Email local part: ph10
347  Email domain: cam.ac.uk  Email domain: cam.ac.uk
348  Last updated: 24 November 2010  Last updated: 07 December 2012

Legend:
Removed from v.579  
changed lines
  Added in v.1232

  ViewVC Help
Powered by ViewVC 1.1.5