16-bit update of non-man documentation files and the PrepareRelease script.

git-svn-id: svn://vcs.exim.org/pcre/code/trunk@840 2f5784b3-3f2a-0410-8824-cb99058d5e15

1 files changed, 67 insertions, 40 deletions

diff --git a/NON-UNIX-USE b/NON-UNIX-USE
index a2657e6..fef073b 100644
--- a/NON-UNIX-USE
+++ b/NON-UNIX-USE
@@ -88,14 +88,10 @@ hand":
        pcre_internal.h
        ucp.h
 
- (5) Also ensure that you have the following file, which is #included as source
-     when building a debugging version of PCRE, and is also used by pcretest.
-
-       pcre_printint.src
-
- (6) Compile the following source files, setting -DHAVE_CONFIG_H as a compiler
-     option if you have set up config.h with your configuration, or else use
-     other -D settings to change the configuration as required.
+ (5) For an 8-bit library, compile the following source files, setting
+     -DHAVE_CONFIG_H as a compiler option if you have set up config.h with your
+     configuration, or else use other -D settings to change the configuration
+     as required.
 
        pcre_byte_order.c
        pcre_chartables.c
@@ -106,11 +102,11 @@ hand":
        pcre_fullinfo.c
        pcre_get.c
        pcre_globals.c
-       pcre_info.c
        pcre_maketables.c
        pcre_newline.c
        pcre_ord2utf8.c
        pcre_refcount.c
+       pcre_string_utils.c 
        pcre_study.c
        pcre_tables.c
        pcre_ucd.c
@@ -122,37 +118,67 @@ hand":
      an unusual compiler) so that all included PCRE header files are first
      sought in the current directory. Otherwise you run the risk of picking up
      a previously-installed file from somewhere else.
-
- (7) If you have defined SUPPORT_JIT in config.h, you must also compile
+     
+ (6) If you have defined SUPPORT_JIT in config.h, you must also compile
 
        pcre_jit_compile.c
 
      This file #includes sources from the sljit subdirectory, where there
      should be 16 files, all of whose names begin with "sljit".
 
- (8) Now link all the compiled code into an object library in whichever form
-     your system keeps such libraries. This is the basic PCRE C library. If
-     your system has static and shared libraries, you may have to do this once
-     for each type.
-
- (9) Similarly, if you want to build the POSIX wrapper functions, ensure that
-     you have the pcreposix.h file and then compile pcreposix.c (remembering
-     -DHAVE_CONFIG_H if necessary). Link the result (on its own) as the
-     pcreposix library.
-
-(10) Compile the test program pcretest.c (again, don't forget -DHAVE_CONFIG_H).
-     This needs the functions in the PCRE library when linking. It also needs
-     the pcreposix wrapper functions unless you compile it with -DNOPOSIX. The
-     pcretest.c program also needs the pcre_printint.src source file, which it
-     #includes.
+ (7) Now link all the compiled code into an object library in whichever form
+     your system keeps such libraries. This is the basic PCRE C 8-bit library.
+     If your system has static and shared libraries, you may have to do this
+     once for each type.
+     
+ (8) If you want to build a 16-bit library (as well as, or instead of the 8-bit 
+     library) repeat steps 5-7 with the following files:
+
+       pcre16_byte_order.c
+       pcre16_chartables.c
+       pcre16_compile.c
+       pcre16_config.c
+       pcre16_dfa_exec.c
+       pcre16_exec.c
+       pcre16_fullinfo.c
+       pcre16_get.c
+       pcre16_globals.c
+       pcre16_jit_compile.c (if SUPPORT_JIT is defined)
+       pcre16_maketables.c
+       pcre16_newline.c
+       pcre16_ord2utf16.c
+       pcre16_refcount.c
+       pcre16_string_utils.c 
+       pcre16_study.c
+       pcre16_tables.c
+       pcre16_ucd.c
+       pcre16_utf16_utils.c 
+       pcre16_valid_utf16.c
+       pcre16_version.c
+       pcre16_xclass.c
+
+ (9) If you want to build the POSIX wrapper functions (which apply only to the 
+     8-bit library), ensure that you have the pcreposix.h file and then compile
+     pcreposix.c (remembering -DHAVE_CONFIG_H if necessary). Link the result
+     (on its own) as the pcreposix library.
+
+(10) The pcretest program can be linked with either or both of the 8-bit and
+     16-bit libraries (depending on what you selected in config.h). Compile
+     pcretest.c and pcre_printint.c (again, don't forget -DHAVE_CONFIG_H) and
+     link them together with the appropriate library/ies. If you compiled an
+     8-bit library, pcretest also needs the pcreposix wrapper library unless
+     you compiled it with -DNOPOSIX.
 
 (11) Run pcretest on the testinput files in the testdata directory, and check
-     that the output matches the corresponding testoutput files. Some tests are
-     relevant only when certain build-time options are selected. For example,
-     test 4 is for UTF-8 support, and will not run if you have build PCRE
-     without it. See the comments at the start of each testinput file. If you
-     have a suitable Unix-like shell, the RunTest script will run the
-     appropriate tests for you.
+     that the output matches the corresponding testoutput files. If you 
+     compiled both an 8-bit and a 16-bit library, you need to run pcretest with 
+     the -16 option to do 16-bit tests.
+       
+     Some tests are relevant only when certain build-time options are selected.
+     For example, test 4 is for UTF-8 or UTF-16 support, and will not run if
+     you have built PCRE without it. See the comments at the start of each
+     testinput file. If you have a suitable Unix-like shell, the RunTest script
+     will run the appropriate tests for you.
 
      Note that the supplied files are in Unix format, with just LF characters
      as line terminators. You may need to edit them to change this if your
@@ -167,17 +193,18 @@ hand":
      the JIT test program, pcre_jit_test.c.
 
 (13) If you want to use the pcregrep command, compile and link pcregrep.c; it
-     uses only the basic PCRE library (it does not need the pcreposix library).
+     uses only the basic 8-bit PCRE library (it does not need the pcreposix
+     library).
 
 
 THE C++ WRAPPER FUNCTIONS
 
-The PCRE distribution also contains some C++ wrapper functions and tests,
-contributed by Google Inc. On a system that can use "configure" and "make",
-the functions are automatically built into a library called pcrecpp. It should
-be straightforward to compile the .cc files manually on other systems. The
-files called xxx_unittest.cc are test programs for each of the corresponding
-xxx.cc files.
+The PCRE distribution also contains some C++ wrapper functions and tests, 
+applicable to the 8-bit library, which were contributed by Google Inc. On a
+system that can use "configure" and "make", the functions are automatically
+built into a library called pcrecpp. It should be straightforward to compile
+the .cc files manually on other systems. The files called xxx_unittest.cc are
+test programs for each of the corresponding xxx.cc files.
 
 
 BUILDING FOR VIRTUAL PASCAL
@@ -547,5 +574,5 @@ build.log file in the root of the package also.
 
 
 =========================
-Last Updated: 9 October 2011
+Last Updated: 30 December 2011
 ****