59d4711da7f43531c6b6d27e574bfb672bcd15e7
[gcc.git] / maintainer-scripts / gcc_release
1 #! /bin/sh
2
3 ########################################################################
4 #
5 # File: gcc_release
6 # Author: Jeffrey Law, Bernd Schmidt, Mark Mitchell
7 # Date: 2001-05-25
8 #
9 # Contents:
10 # Script to create a GCC release.
11 #
12 # Copyright (c) 2001 Free Software Foundation.
13 #
14 # This file is part of GNU CC.
15 #
16 # GNU CC is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2, or (at your option)
19 # any later version.
20 #
21 # GNU CC is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
25 #
26 # You should have received a copy of the GNU General Public License
27 # along with GNU CC; see the file COPYING. If not, write to
28 # the Free Software Foundation, 59 Temple Place - Suite 330,
29 # Boston, MA 02111-1307, USA.
30 #
31 ########################################################################
32
33 ########################################################################
34 # Notes
35 ########################################################################
36
37 # Here is an example usage of this script, to create a GCC 3.0.2
38 # prerelease:
39 #
40 # gcc_release -r 3.0.2
41 #
42 # This script will automatically use the head of the release branch
43 # to generate the release.
44
45 ########################################################################
46 # Functions
47 ########################################################################
48
49 # Issue the error message given by $1 and exit with a non-zero
50 # exit code.
51
52 error() {
53 echo "gcc_release: error: $1"
54 exit 1
55 }
56
57 # Issue the informational message given by $1.
58
59 inform() {
60 echo "gcc_release: $1"
61 }
62
63 # Issue a usage message explaining how to use this script.
64
65 usage() {
66 cat <<EOF
67 gcc_release [-d destination]
68 [-u username]
69 [-r release]
70 [-t tag]
71 [-p previous-tarball]
72 [-s] [-f] [-l]
73 EOF
74 exit 1
75 }
76
77 # Change to the directory given by $1.
78
79 changedir() {
80 cd $1 || \
81 error "Could not change directory to $1"
82 }
83
84 # Each of the arguments is a directory name, relative to the top
85 # of the source tree. Return another name for that directory, relative
86 # to the working directory.
87
88 adjust_dirs() {
89 for x in $@; do
90 echo `basename ${SOURCE_DIRECTORY}`/$x
91 done
92 }
93
94 # Build the source tree that will be the basis for the release
95 # in ${WORKING_DIRECTORY}/gcc-${RELEASE}.
96
97 build_sources() {
98 # If the WORKING_DIRECTORY already exists, do not risk destroying it.
99 if [ -r ${WORKING_DIRECTORY} ]; then
100 error "\`${WORKING_DIRECTORY}' already exists"
101 fi
102 # Create the WORKING_DIRECTORY.
103 mkdir "${WORKING_DIRECTORY}" \
104 || error "Could not create \`${WORKING_DIRECTORY}'"
105 changedir "${WORKING_DIRECTORY}"
106
107 # If this is a final release, make sure that the ChangeLogs
108 # and version strings are updated.
109 if [ ${FINAL} -ne 0 ]; then
110 inform "Updating ChangeLogs and version files"
111
112 ${CVS} co -d "`basename ${SOURCE_DIRECTORY}`" \
113 -r ${BRANCH} gcc || \
114 error "Could not check out release sources"
115 for x in `find ${SOURCE_DIRECTORY} -name ChangeLog`; do
116 cat - ${x} > ${x}.new <<EOF
117 ${LONG_DATE} Release Manager
118
119 * GCC ${RELEASE} Released.
120
121 EOF
122 mv ${x}.new ${x} || \
123 error "Could not update ${x}"
124 (changedir `dirname ${x}` && \
125 ${CVS} ci -m 'Mark ChangeLog' `basename ${x}`) || \
126 error "Could not commit ${x}"
127 done
128
129 # Update `gcc/version.c'. There are other version files
130 # as well, which should have release status updated.
131 for x in gcc/version.c; do
132 y=`basename ${x}`
133 (changedir `dirname ${SOURCE_DIRECTORY}/${x}` && \
134 sed -e 's|= \".*\"|= \"'${RELEASE}'\"|g' < ${y} > ${y}.new && \
135 mv ${y}.new ${y} && \
136 ${CVS} ci -m 'Update version' ${y}) || \
137 error "Could not update ${x}"
138 done
139 for x in gcc/f/version.c libf2c/libF77/Version.c \
140 libf2c/libI77/Version.c libf2c/libU77/Version.c; do
141 y=`basename ${x}`
142 (changedir `dirname ${SOURCE_DIRECTORY}/${x}` && \
143 sed -e 's/experimental\|prerelease/release/g' < ${y} > ${y}.new && \
144 mv ${y}.new ${y} && \
145 ${CVS} ci -m 'Update version' ${y}) || \
146 error "Could not update ${x}"
147 done
148
149 # Make sure we tag the sources for a final release.
150 TAG="gcc_`echo ${RELEASE} | tr . _`_release"
151
152 rm -rf ${SOURCE_DIRECTORY}
153 fi
154
155 # Tag the sources.
156 if [ -n "${TAG}" ]; then
157 inform "Tagging release sources"
158 ${CVS} rtag -r ${BRANCH} -F ${TAG} gcc || \
159 error "Could not tag release sources"
160 BRANCH=$TAG
161 fi
162
163 # Export the current sources.
164 inform "Retrieving release sources"
165 ${CVS} \
166 export -d "`basename ${SOURCE_DIRECTORY}`" \
167 -r ${BRANCH} gcc || \
168 error "Could not retrieve release sources"
169
170 # Run gcc_update on them to set up the timestamps nicely.
171 changedir "gcc-${RELEASE}"
172 contrib/gcc_update --touch
173
174 # Obtain some documentation files from the wwwdocs module.
175 inform "Retrieving HTML documentation"
176 changedir "${WORKING_DIRECTORY}"
177 for x in bugs gnats faq; do
178 (${CVS} export -r HEAD wwwdocs/htdocs/${x}.html && \
179 cp ${WORKING_DIRECTORY}/wwwdocs/htdocs/${x}.html \
180 ${SOURCE_DIRECTORY}) || \
181 error "Could not retrieve ${x}.html"
182 done
183
184 inform "Generating plain-text documentation from HTML"
185 changedir "${SOURCE_DIRECTORY}"
186 for file in *.html; do
187 newfile=`echo $file | sed -e 's/.html//' | tr "[:lower:]" "[:upper:]"`
188 (${ENV} TERM=vt100 lynx -dump $file \
189 | sed -e "s#file://localhost`/bin/pwd`\(.*\)#http://gcc.gnu.org\1#g" \
190 > $newfile) || \
191 error "Could not regenerate documentation"
192 done
193
194 # For a prerelease or real release, we need to generate additional
195 # files not present in CVS.
196 changedir "${SOURCE_DIRECTORY}"
197 if [ $SNAPSHOT -ne 1 ]; then
198 # Generate the documentation.
199 inform "Building install docs"
200 SOURCEDIR=${SOURCE_DIRECTORY}/gcc/doc
201 DESTDIR=${SOURCE_DIRECTORY}/INSTALL
202 export SOURCEDIR
203 export DESTDIR
204 ${SOURCE_DIRECTORY}/gcc/doc/install.texi2html
205
206 # Regenerate the NEWS file.
207 contrib/gennews > gcc/NEWS || \
208 error "Could not regenerate NEWS files"
209
210 # Now, we must build the compiler in order to create any generated
211 # files that are supposed to go in the source directory. This is
212 # also a good sanity check to make sure that the release builds
213 # on at least one platform.
214 inform "Building compiler"
215 OBJECT_DIRECTORY=../objdir
216 contrib/gcc_build -d ${SOURCE_DIRECTORY} -o ${OBJECT_DIRECTORY} build || \
217 error "Could not rebuild GCC"
218
219 # Regenerate the Fotran NEWS and BUGS files.
220 (cd ${OBJECT_DIRECTORY}/gcc && make f77.rebuilt) || \
221 error "Could not regenerate Fortran NEWS and BUGS files"
222 fi
223
224 # Move message catalogs to source directory.
225 mv ../objdir/gcc/po/*.gmo gcc/po/
226
227 # Create a `.brik' file to use for checking the validity of the
228 # release.
229 changedir "${SOURCE_DIRECTORY}"
230 BRIK_FILE=`mktemp /tmp/gcc_release.XXXXXXX`
231 ((find . -type f | sort > $BRIK_FILE) && \
232 brik -Gb -f ${BRIK_FILE} > .brik && \
233 rm ${BRIK_FILE}) || \
234 error "Could not compute brik checksum"
235 }
236
237 # Buid a single tarfile. The first argument is the name of the name
238 # of the tarfile to build, without any suffixes. They will be added
239 # automatically. The rest of the arguments are the files or
240 # directories to include.
241
242 build_tarfile() {
243 # Get the name of the destination tar file.
244 TARFILE="$1.tar.gz"
245 shift
246
247 # Build the tar file itself.
248 (${TAR} cf - "$@" | ${GZIP} > ${TARFILE}) || \
249 error "Could not build tarfile"
250 FILE_LIST="${FILE_LIST} ${TARFILE}"
251 }
252
253 # Build the various tar files for the release.
254
255 build_tarfiles() {
256 inform "Building tarfiles"
257
258 changedir "${WORKING_DIRECTORY}"
259
260 # The GNU Coding Standards specify that all files should
261 # world readable.
262 chmod -R a+r ${SOURCE_DIRECTORY}
263 # And that all directories have mode 777.
264 find ${SOURCE_DIRECTORY} -type d -exec chmod 777 {} \;
265
266 # Build one huge tarfile for the entire distribution.
267 build_tarfile gcc-${RELEASE} `basename ${SOURCE_DIRECTORY}`
268
269 # Now, build one for each of the languages.
270 build_tarfile gcc-g++-${RELEASE} ${CPLUSPLUS_DIRS}
271 build_tarfile gcc-g77-${RELEASE} ${FORTRAN_DIRS}
272 build_tarfile gcc-java-${RELEASE} ${JAVA_DIRS}
273 build_tarfile gcc-objc-${RELEASE} ${OBJECTIVEC_DIRS}
274 build_tarfile gcc-testsuite-${RELEASE} ${TESTSUITE_DIRS}
275
276 # The core is everything else.
277 EXCLUDES=""
278 for x in ${CPLUSPLUS_DIRS} ${FORTRAN_DIRS} ${JAVA_DIRS} \
279 ${OBJECTIVEC_DIRS} ${TESTSUITE_DIRS}; do
280 EXCLUDES="${EXCLUDES} --exclude $x"
281 done
282 build_tarfile gcc-core-${RELEASE} ${EXCLUDES} \
283 `basename ${SOURCE_DIRECTORY}`
284
285 # Possibly build diffs.
286 if [ -n "$OLD_TARS" ]; then
287 for old_tar in $OLD_TARS; do
288 build_diffs $old_tar
289 done
290 fi
291
292 # Build .bz2 files.
293 for f in ${FILE_LIST}; do
294 bzfile=${f%.gz}.bz2
295 zcat $f | ${BZIP2} > ${bzfile}
296 FILE_LIST="${FILE_LIST} ${bzfile}"
297 done
298 }
299
300 # Build diffs against an old release.
301 build_diffs() {
302 old_dir=${1%/*}
303 old_file=${1##*/}
304 old_vers=${old_file%.tar.gz}
305 old_vers=${old_vers#gcc-}
306 inform "Building diffs against version $old_vers"
307 for f in gcc gcc-g++ gcc-g77 gcc-java gcc-objc gcc-testsuite gcc-core; do
308 old_tar=${old_dir}/${f}-${old_vers}.tar.gz
309 new_tar=${WORKING_DIRECTORY}/${f}-${RELEASE}.tar.gz
310 if [ -e $old_tar ] && [ -e $new_tar ]; then
311 build_diff $old_tar gcc-${old_vers} $new_tar gcc-${RELEASE} \
312 ${f}-${old_vers}-${RELEASE}.diff.gz
313 fi
314 done
315 }
316
317 # Build an individual diff.
318 build_diff() {
319 changedir "${WORKING_DIRECTORY}"
320 tmpdir=gccdiff.$$
321 mkdir $tmpdir || error "Could not create directory $tmpdir"
322 changedir $tmpdir
323 tar xfz $1 || error "Could not unpack $1 for diffs"
324 tar xfz $3 || error "Could not unpack $3 for diffs"
325 ${DIFF} $2 $4 | ${GZIP} > ../$5
326 if [ $? -eq 2 ]; then
327 error "Trouble making diffs from $1 to $3"
328 fi
329 changedir ..
330 rm -rf $tmpdir
331 FILE_LIST="${FILE_LIST} $5"
332 }
333
334 # Upload the files to the FTP server.
335
336 upload_files() {
337 inform "Uploading files"
338
339 changedir "${WORKING_DIRECTORY}"
340
341 if [ $LOCAL -ne 0 ]; then
342 mkdir -p "${FTP_PATH}" \
343 || error "Could not create \`${FTP_PATH}'"
344 fi
345
346 # Copy the tar files to the FTP server.
347 for x in gcc*.gz gcc*.bz2; do
348 if [ -e ${x} ]; then
349 # Make sure the file will be readable on the server.
350 chmod a+r ${x}
351 # Copy it.
352 ${SCP} ${x} ${FTP_PATH} || \
353 error "Could not upload ${x}"
354 fi
355 done
356 }
357
358 ########################################################################
359 # Initialization
360 ########################################################################
361
362 # Today's date.
363 DATE=`date "+%Y%m%d"`
364 LONG_DATE=`date "+%Y-%m-%d"`
365
366 # The CVS server containing the GCC repository.
367 CVS_SERVER="gcc.gnu.org"
368 # The path to the repository on that server.
369 CVS_REPOSITORY="/cvs/gcc"
370 # The CVS protocol to use.
371 CVS_PROTOCOL="ext"
372 # The username to use when connecting to the server.
373 CVS_USERNAME="${USER}"
374
375 # The path to the directory where the files are uploaded for FTP.
376 FTP_PATH="gccadmin@gcc.gnu.org:~ftp/pub/gcc"
377
378 # The major number for the release. For release `3.0.2' this would be
379 # `3'
380 RELEASE_MAJOR=""
381 # The minor number for the release. For release `3.0.2' this would be
382 # `0'.
383 RELEASE_MINOR=""
384 # The revision number for the release. For release `3.0.2' this would
385 # be `2'.
386 RELEASE_REVISION=""
387 # The complete name of the release.
388 RELEASE=""
389
390 # The name of the branch from which the release should be made.
391 BRANCH=""
392
393 # The tag to apply to the sources used for the release.
394 TAG=""
395
396 # The old tarballs from which to generate diffs.
397 OLD_TARS=""
398
399 # The directory that will be used to construct the release. The
400 # release itself will be placed in a subdirectory of this diretory.
401 DESTINATION=${HOME}
402 # The subdirectory.
403 WORKING_DIRECTORY=""
404 # The directory that will contain the GCC sources.
405 SOURCE_DIRECTORY=""
406
407 # The directories that should be part of the various language-specific
408 # tar files. These are all relative to the top of the source tree.
409 CPLUSPLUS_DIRS="gcc/cp libstdc++-v3"
410 FORTRAN_DIRS="gcc/f libf2c"
411 JAVA_DIRS="gcc/java libjava libffi fastjar zlib boehm-gc"
412 OBJECTIVEC_DIRS="gcc/objc libobjc"
413 TESTSUITE_DIRS="gcc/testsuite"
414
415 # Non-zero if this is the final release, rather than a prerelease.
416 FINAL=0
417
418 # Non-zero if we are building a snapshot, and don't build gcc or
419 # include generated files.
420 SNAPSHOT=0
421
422 # Non-zero if we are running locally on gcc.gnu.org, and use local CVS
423 # and copy directly to the FTP directory.
424 LOCAL=0
425
426 # Major operation modes.
427 MODE_SOURCES=0
428 MODE_TARFILES=0
429 MODE_UPLOAD=0
430
431 # Files generated to upload.
432 FILE_LIST=""
433
434 # Programs we use.
435
436 BZIP2="${BZIP2:-bzip2}"
437 CVS="${CVS:-cvs -f -Q -z9}"
438 DIFF="${DIFF:-diff -Nrc3pad}"
439 ENV="${ENV:-env}"
440 GZIP="${GZIP:-gzip --best}"
441 SCP="${SCP:-scp -p}"
442 TAR="${TAR:-tar}"
443
444 ########################################################################
445 # Command Line Processing
446 ########################################################################
447
448 # Parse the options.
449 while getopts "d:fr:u:t:p:sl" ARG; do
450 case $ARG in
451 d) DESTINATION="${OPTARG}";;
452 r) RELEASE="${OPTARG}";;
453 t) TAG="${OPTARG}";;
454 u) CVS_USERNAME="${OPTARG}";;
455 f) FINAL=1;;
456 s) SNAPSHOT=1;;
457 l) LOCAL=1
458 SCP=cp
459 FTP_PATH=~ftp/pub/gcc
460 PATH=~:$PATH;;
461 p) OLD_TARS="${OLD_TARS} ${OPTARG}";;
462 \?) usage;;
463 esac
464 done
465 shift `expr ${OPTIND} - 1`
466
467 # Perform consistency checking.
468 if [ -z ${CVS_USERNAME} ]; then
469 error "No username specified"
470 fi
471
472 if [ ! -d ${DESTINATION} ]; then
473 error "\`${DESTINATION}' is not a directory"
474 fi
475
476 if [ $SNAPSHOT -eq 0 ]; then
477 if [ -z ${RELEASE} ]; then
478 error "No release number specified"
479 fi
480
481 # Compute the major and minor release numbers.
482 RELEASE_MAJOR=`echo $RELEASE | awk --assign FS=. '{ print $1; }'`
483 RELEASE_MINOR=`echo $RELEASE | awk --assign FS=. '{ print $2; }'`
484 RELEASE_REVISION=`echo $RELEASE | awk --assign FS=. '{ print $3; }'`
485
486 if [ -z "${RELEASE_MAJOR}" ] || [ -z "${RELEASE_MINOR}" ]; then
487 error "Release number \`${RELEASE}' is invalid"
488 fi
489
490 # Compute the full name of the release.
491 if [ -z "${RELEASE_REVISION}" ]; then
492 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}"
493 else
494 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}.${RELEASE_REVISION}"
495 fi
496
497 # Compute the name of the branch, which is based solely on the major
498 # and minor release numbers.
499 BRANCH="gcc-${RELEASE_MAJOR}_${RELEASE_MINOR}-branch"
500
501 # If this is not a final release, set various parameters acordingly.
502 if [ ${FINAL} -ne 1 ]; then
503 RELEASE="${RELEASE}-${DATE}"
504 FTP_PATH="${FTP_PATH}/snapshots"
505 else
506 FTP_PATH="${FTP_PATH}/releases/gcc-${RELEASE}"
507 fi
508 else
509 RELEASE=$DATE
510 # For now snapshots come from the 3.0 branch.
511 BRANCH=gcc-3_0-branch
512 FTP_PATH="${FTP_PATH}/snapshots/${LONG_DATE}"
513 TAG=gcc_ss_${DATE}
514
515 # Building locally on gcc.gnu.org, we know what the last snapshot date
516 # was.
517 if [ $LOCAL -ne 0 ]; then
518 LAST_DATE=`cat ~/.snapshot_date`
519 PREV_LAST_DATE=`cat ~/.prev_snapshot_date`
520 LAST_LONG_DATE=`date --date=$LAST_DATE +%Y-%m-%d`
521 LAST_DIR=~ftp/pub/gcc/snapshots/${LAST_LONG_DATE}
522 OLD_TARS=${LAST_DIR}/gcc-${LAST_DATE}.tar.gz
523 fi
524 fi
525
526 # Compute the name of the WORKING_DIRECTORY and the SOURCE_DIRECTORY.
527 WORKING_DIRECTORY="${DESTINATION}/gcc-${RELEASE}"
528 SOURCE_DIRECTORY="${WORKING_DIRECTORY}/gcc-${RELEASE}"
529
530 # Recompute the names of all the language-specific directories,
531 # relative to the WORKING_DIRECTORY.
532 CPLUSPLUS_DIRS=`adjust_dirs ${CPLUSPLUS_DIRS}`
533 FORTRAN_DIRS=`adjust_dirs ${FORTRAN_DIRS}`
534 JAVA_DIRS=`adjust_dirs ${JAVA_DIRS}`
535 OBJECTIVEC_DIRS=`adjust_dirs ${OBJECTIVEC_DIRS}`
536 TESTSUITE_DIRS=`adjust_dirs ${TESTSUITE_DIRS}`
537
538 # Set up CVSROOT.
539 if [ $LOCAL -eq 0 ]; then
540 CVSROOT=":${CVS_PROTOCOL}:${CVS_USERNAME}@"
541 CVSROOT="${CVSROOT}${CVS_SERVER}:${CVS_REPOSITORY}"
542 else
543 CVSROOT="${CVS_REPOSITORY}"
544 fi
545 export CVSROOT
546
547 ########################################################################
548 # Main Program
549 ########################################################################
550
551 # Handle the major modes.
552 while [ $# -ne 0 ]; do
553 case $1 in
554 sources) MODE_SOURCES=1;;
555 tarfiles) MODE_TARFILES=1;;
556 upload) MODE_UPLOAD=1;;
557 all) MODE_SOURCES=1; MODE_TARFILES=1; MODE_UPLOAD=1;;
558 *) error "Unknown mode $1";;
559 esac
560 shift
561 done
562
563 # Build the source directory.
564
565 if [ $MODE_SOURCES -ne 0 ]; then
566 build_sources
567 fi
568
569 # Build the tar files.
570
571 if [ $MODE_TARFILES -ne 0 ]; then
572 build_tarfiles
573 fi
574
575 # Upload them to the FTP server.
576
577 if [ $MODE_UPLOAD -ne 0 ]; then
578 upload_files
579
580 # For snapshots, make some further updates.
581 if [ $SNAPSHOT -ne 0 ] && [ $LOCAL -ne 0 ]; then
582 # Update links on the FTP server.
583 TEXT_DATE=`date --date=$DATE +%B\ %d,\ %Y`
584 LAST_TEXT_DATE=`date --date=$LAST_DATE +%B\ %d,\ %Y`
585 cd ~ftp/pub/gcc/snapshots
586 sed -e "s%$LAST_DATE%$DATE%g" -e "s%$PREV_LAST_DATE%$LAST_DATE%g" \
587 -e "s%$LAST_LONG_DATE%$LONG_DATE%g" \
588 -e "s%$LAST_TEXT_DATE%$TEXT_DATE%g" < README > $$
589 mv $$ README
590 sed -e "s%$LAST_DATE%$DATE%g" -e "s%$PREV_LAST_DATE%$LAST_DATE%g" \
591 -e "s%$LAST_LONG_DATE%$LONG_DATE%g" \
592 -e "s%$LAST_TEXT_DATE%$TEXT_DATE%g" < index.html > $$
593 mv $$ index.html
594
595 touch LATEST-IS-$LONG_DATE
596 rm -f LATEST-IS-$LAST_LONG_DATE
597
598 # Update snapshot date file.
599 changedir ~
600 mv .snapshot_date .prev_snapshot_date
601 echo $DATE >.snapshot_date
602
603 # Update gcc_latest_snapshot tag.
604 ${CVS} rtag -d gcc_latest_snapshot gcc
605 ${CVS} rtag -rgcc_ss_${DATE} gcc_latest_snapshot gcc
606
607 # Announce the snapshot.
608 mail -s "gcc-ss-$DATE is now available" gcc@gcc.gnu.org < ~ftp/pub/gcc/snapshots/README
609
610 # Remove working directory
611 rm -rf ${WORKING_DIRECTORY}
612 fi
613 fi