/[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 874 by ph10, Sat Jan 14 17:03:15 2012 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 44  pcre_chartables.c.non-standard Line 37  pcre_chartables.c.non-standard
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. The relevant files are CMakeLists.txt    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    and config-cmake.h.in. After making a release tarball, test it out with CMake
# Line 125  distribution for a new release. Line 122  distribution for a new release.
122    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
123    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.
124    
125  . Documentation: check AUTHORS, COPYING, ChangeLog (check version and date),  . Documentation: check AUTHORS, ChangeLog (check version and date), LICENCE,
126    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
127    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.
128    
129  . 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
130    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 133  distribution for a new release.
133    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
134    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
135    folks on the pcre-dev list to test.    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    The following explanation may help in understanding the above rules a bit
164    better. Consider that there are three possible kinds of reaction from users to
165    changes in a shared library:
166    
167    1. Programs using the previous version may use the new version as a drop-in
168       replacement, and programs using the new version can also work with the
169       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    
172    2. Programs using the previous version may use the new version as a drop-in
173       replacement, but programs using the new version may use APIs not present in
174       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       revision to 0, increment current and age.
177    
178    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.
180    
181    
182  Making a PCRE release  Making a PCRE release
# Line 231  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 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 291  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 310  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: 14 January 2012  Last updated: 07 December 2012

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

  ViewVC Help
Powered by ViewVC 1.1.5