Contents of /code/trunk/PrepareRelease

#/bin/sh

# Script to prepare the files for building a PCRE release. It does some
# processing of the documentation, detrails files, and creates pcre.h.generic
# and config.h.generic (for use by builders who can't run ./configure).

# You must run this script before runnning "make dist". It makes use of the
# following files:

# 132html     A Perl script that converts a .1 or .3 man page into HTML. It
#             is called from MakeRelease. It "knows" the relevant troff
#             constructs that are used in the PCRE man pages.

# CleanTxt    A Perl script that cleans up the output of "nroff -man" by
#             removing backspaces and other redundant text so as to produce
#             a readable .txt file.

# Detrail     A Perl script that removes trailing spaces from files.

# Index.html  A file that is copied as index.html into the doc/html
#             directory when the HTML documentation is built. It works like
#             this so that doc/html can be deleted and re-created from scratch.


# First, sort out the documentation

cd doc
echo Processing documentation

# Make Text form of the documentation. It needs some mangling to make it
# tidy for online reading. Concatenate all the .3 stuff, but omit the
# individual function pages.

cat <<End >pcre.txt
-----------------------------------------------------------------------------
This file contains a concatenation of the PCRE man pages, converted to plain
text format for ease of searching with a text editor, or for use on systems
that do not have a man page processor. The small individual files that give
synopses of each function in the library have not been included. There are
separate text files for the pcregrep and pcretest commands.
-----------------------------------------------------------------------------


End

echo "Making pcre.txt"
for file in pcre pcrebuild pcrematching pcreapi pcrecallout pcrecompat \
            pcrepattern pcrepartial pcreprecompile \
            pcreperform pcreposix pcrecpp pcresample pcrestack ; do
  echo "  Processing $file.3"
  nroff -c -man $file.3 >$file.rawtxt
  ../CleanTxt <$file.rawtxt >>pcre.txt
  /bin/rm $file.rawtxt
  echo "------------------------------------------------------------------------------" >>pcre.txt
  if [ "$file" != "pcresample" ] ; then
    echo " " >>pcre.txt
    echo " " >>pcre.txt
  fi
done

# The two commands
for file in pcretest pcregrep ; do
  echo Making $file.txt
  nroff -c -man $file.1 >$file.rawtxt
  ../CleanTxt <$file.rawtxt >$file.txt
  /bin/rm $file.rawtxt
done


# Make HTML form of the documentation.

echo "Making HTML documentation"
/bin/rm html/*
cp ../Index.html html/index.html

for file in *.1 ; do
  base=`basename $file .1`
  echo "  Making $base.html"
  ../132html -toc $base <$file >html/$base.html
done

# Exclude table of contents for function summaries. It seems that expr
# forces an anchored regex. Also exclude them for small pages that have
# only one section.
for file in *.3 ; do
  base=`basename $file .3`
  toc=-toc
  if [ `expr $base : '.*_'` -ne 0 ] ; then toc="" ; fi
  if [ "$base" = "pcresample" ] || \
     [ "$base" = "pcrestack" ]  || \
     [ "$base" = "pcrecompat" ] || \
     [ "$base" = "pcreperform" ] ; then
    toc=""
  fi
  echo "  Making $base.html"
  ../132html $toc $base <$file >html/$base.html
  if [ $? != 0 ] ; then exit 1; fi
done

# End of documentation processing

cd ..
echo Documentation done

# These files are detrailed; do not detrail the test data because there may be
# significant trailing spaces. The configure files are also omitted from the
# detrailing.

files="\
  Makefile.am \
  Makefile.in \
  configure.ac \
  README \
  LICENCE \
  COPYING \
  AUTHORS \
  NEWS \
  NON-UNIX-USE \
  INSTALL \
  132html \
  CleanTxt \
  Detrail \
  ChangeLog \
  CMakeLists.txt \
  RunGrepTest.in \
  RunTest.in \
  RunTest.bat \
  pcre-config.in \
  libpcre.pc.in \
  libpcrecpp.pc.in \
  config.h \
  config.h.in \
  pcre_printint.src \
  pcredemo.c \
  pcregrep.c \
  pcretest.c \
  dftables.c \
  pcreposix.c \
  pcreposix.h \
  pcre.h \
  pcre.h.in \
  pcre_internal.h
  pcre_compile.c \
  pcre_config.c \
  pcre_dfa_exec.c \
  pcre_exec.c \
  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_study.c \
  pcre_tables.c \
  pcre_try_flipped.c \
  pcre_ucp_searchfuncs.c \
  pcre_valid_utf8.c \
  pcre_version.c \
  pcre_xclass.c \
  pcre_scanner.cc \
  pcre_scanner.h \
  pcre_scanner_unittest.cc \
  pcrecpp.cc \
  pcrecpp.h \
  pcrecpparg.h.in \
  pcrecpp_unittest.cc \
  pcre_stringpiece.cc \
  pcre_stringpiece.h.in \
  pcre_stringpiece_unittest.cc \
  perltest.pl \
  ucp.h \
  ucpinternal.h \
  ucptable.h \
  makevp.bat \
  pcre.def \
  libpcre.def \
  libpcreposix.def"

echo Detrailing
./Detrail $files doc/p* doc/html/*

echo Converting pcre.h and config.h to generic forms
cp -f pcre.h pcre.h.generic

perl <<'END'
  open(IN, "<config.h") || die "Can't open config.h: $!\n";
  open(OUT, ">config.h.generic") || die "Can't open config.h.generic: $!\n";
  while (<IN>)
    {
    if (/^#define\s(?!PACKAGE)(\w+)/)
      {
      print OUT "#ifndef $1\n";
      print OUT;
      print OUT "#endif\n";
      }
    else
      {
      print OUT;
      }
    }
  close IN;
  close OUT;
END

#End
1	ph10	97	#/bin/sh
2
3	ph10	111	# Script to prepare the files for building a PCRE release. It does some
4			# processing of the documentation, detrails files, and creates pcre.h.generic
5			# and config.h.generic (for use by builders who can't run ./configure).
6	ph10	97
7	ph10	111	# You must run this script before runnning "make dist". It makes use of the
8			# following files:
9	ph10	97
10	ph10	111	# 132html A Perl script that converts a .1 or .3 man page into HTML. It
11			# is called from MakeRelease. It "knows" the relevant troff
12			# constructs that are used in the PCRE man pages.
13	ph10	97
14	ph10	111	# CleanTxt A Perl script that cleans up the output of "nroff -man" by
15			# removing backspaces and other redundant text so as to produce
16			# a readable .txt file.
17	ph10	97
18	ph10	111	# Detrail A Perl script that removes trailing spaces from files.
19	ph10	97
20	ph10	111	# Index.html A file that is copied as index.html into the doc/html
21			# directory when the HTML documentation is built. It works like
22			# this so that doc/html can be deleted and re-created from scratch.
23	ph10	97
24
25			# First, sort out the documentation
26
27			cd doc
28			echo Processing documentation
29
30			# Make Text form of the documentation. It needs some mangling to make it
31			# tidy for online reading. Concatenate all the .3 stuff, but omit the
32			# individual function pages.
33
34			cat <<End >pcre.txt
35			-----------------------------------------------------------------------------
36			This file contains a concatenation of the PCRE man pages, converted to plain
37			text format for ease of searching with a text editor, or for use on systems
38			that do not have a man page processor. The small individual files that give
39			synopses of each function in the library have not been included. There are
40			separate text files for the pcregrep and pcretest commands.
41			-----------------------------------------------------------------------------
42
43
44			End
45
46			echo "Making pcre.txt"
47			for file in pcre pcrebuild pcrematching pcreapi pcrecallout pcrecompat \
48			pcrepattern pcrepartial pcreprecompile \
49			pcreperform pcreposix pcrecpp pcresample pcrestack ; do
50			echo " Processing $file.3"
51			nroff -c -man $file.3 >$file.rawtxt
52	ph10	111	../CleanTxt <$file.rawtxt >>pcre.txt
53	ph10	97	/bin/rm $file.rawtxt
54			echo "------------------------------------------------------------------------------" >>pcre.txt
55			if [ "$file" != "pcresample" ] ; then
56			echo " " >>pcre.txt
57			echo " " >>pcre.txt
58			fi
59			done
60
61			# The two commands
62			for file in pcretest pcregrep ; do
63			echo Making $file.txt
64			nroff -c -man $file.1 >$file.rawtxt
65	ph10	111	../CleanTxt <$file.rawtxt >$file.txt
66	ph10	97	/bin/rm $file.rawtxt
67			done
68
69
70			# Make HTML form of the documentation.
71
72	ph10	111	echo "Making HTML documentation"
73	ph10	97	/bin/rm html/*
74	ph10	111	cp ../Index.html html/index.html
75	ph10	97
76			for file in *.1 ; do
77			base=`basename $file .1`
78	ph10	111	echo " Making $base.html"
79			../132html -toc $base <$file >html/$base.html
80	ph10	97	done
81
82			# Exclude table of contents for function summaries. It seems that expr
83			# forces an anchored regex. Also exclude them for small pages that have
84			# only one section.
85			for file in *.3 ; do
86			base=`basename $file .3`
87			toc=-toc
88			if [ `expr $base : '.*_'` -ne 0 ] ; then toc="" ; fi
89			if [ "$base" = "pcresample" ] \|\| \
90			[ "$base" = "pcrestack" ] \|\| \
91			[ "$base" = "pcrecompat" ] \|\| \
92			[ "$base" = "pcreperform" ] ; then
93			toc=""
94			fi
95	ph10	111	echo " Making $base.html"
96			../132html $toc $base <$file >html/$base.html
97			if [ $? != 0 ] ; then exit 1; fi
98	ph10	97	done
99
100			# End of documentation processing
101
102			cd ..
103			echo Documentation done
104
105	ph10	111	# These files are detrailed; do not detrail the test data because there may be
106			# significant trailing spaces. The configure files are also omitted from the
107			# detrailing.
108	ph10	97
109	ph10	111	files="\
110			Makefile.am \
111			Makefile.in \
112			configure.ac \
113			README \
114			LICENCE \
115			COPYING \
116			AUTHORS \
117			NEWS \
118			NON-UNIX-USE \
119			INSTALL \
120			132html \
121			CleanTxt \
122			Detrail \
123			ChangeLog \
124			CMakeLists.txt \
125			RunGrepTest.in \
126			RunTest.in \
127			RunTest.bat \
128	ph10	97	pcre-config.in \
129			libpcre.pc.in \
130			libpcrecpp.pc.in \
131	ph10	111	config.h \
132			config.h.in \
133	ph10	97	pcre_printint.src \
134			pcredemo.c \
135			pcregrep.c \
136			pcretest.c \
137			dftables.c \
138			pcreposix.c \
139			pcreposix.h \
140			pcre.h \
141	ph10	111	pcre.h.in \
142	ph10	97	pcre_internal.h
143			pcre_compile.c \
144			pcre_config.c \
145			pcre_dfa_exec.c \
146			pcre_exec.c \
147			pcre_fullinfo.c \
148			pcre_get.c \
149			pcre_globals.c \
150			pcre_info.c \
151			pcre_maketables.c \
152			pcre_newline.c \
153			pcre_ord2utf8.c \
154			pcre_refcount.c \
155			pcre_study.c \
156			pcre_tables.c \
157			pcre_try_flipped.c \
158			pcre_ucp_searchfuncs.c \
159			pcre_valid_utf8.c \
160			pcre_version.c \
161			pcre_xclass.c \
162			pcre_scanner.cc \
163			pcre_scanner.h \
164			pcre_scanner_unittest.cc \
165			pcrecpp.cc \
166			pcrecpp.h \
167			pcrecpparg.h.in \
168			pcrecpp_unittest.cc \
169			pcre_stringpiece.cc \
170			pcre_stringpiece.h.in \
171			pcre_stringpiece_unittest.cc \
172			perltest.pl \
173			ucp.h \
174			ucpinternal.h \
175			ucptable.h \
176			makevp.bat \
177			pcre.def \
178			libpcre.def \
179			libpcreposix.def"
180
181			echo Detrailing
182	ph10	111	./Detrail $files doc/p* doc/html/*
183	ph10	97
184	ph10	111	echo Converting pcre.h and config.h to generic forms
185			cp -f pcre.h pcre.h.generic
186	ph10	97
187	ph10	111	perl <<'END'
188			open(IN, "<config.h") \|\| die "Can't open config.h: $!\n";
189			open(OUT, ">config.h.generic") \|\| die "Can't open config.h.generic: $!\n";
190			while (<IN>)
191			{
192			if (/^#define\s(?!PACKAGE)(\w+)/)
193			{
194			print OUT "#ifndef $1\n";
195			print OUT;
196			print OUT "#endif\n";
197			}
198			else
199			{
200			print OUT;
201			}
202			}
203			close IN;
204			close OUT;
205			END
206	ph10	97
207			#End