3 ########################################################################
6 # Author: Jeffrey Law, Bernd Schmidt, Mark Mitchell
10 # Script to create a GCC release.
12 # Copyright (c) 2001, 2002 Free Software Foundation.
14 # This file is part of GCC.
16 # GCC 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)
21 # GCC 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.
26 # You should have received a copy of the GNU General Public License
27 # along with GCC; see the file COPYING. If not, write to
28 # the Free Software Foundation, 59 Temple Place - Suite 330,
29 # Boston, MA 02111-1307, USA.
31 ########################################################################
33 ########################################################################
35 ########################################################################
37 # Here is an example usage of this script, to create a GCC 3.0.2
40 # gcc_release -r 3.0.2
42 # This script will automatically use the head of the release branch
43 # to generate the release.
45 ########################################################################
47 ########################################################################
49 # Issue the error message given by $1 and exit with a non-zero
53 echo "gcc_release: error: $1"
57 # Issue the informational message given by $1.
60 echo "gcc_release: $1"
63 # Issue a usage message explaining how to use this script.
67 gcc_release -r release [-f] [further options]
68 gcc_release -s name:cvsbranch [further options]
72 -r release Version of the form X.Y or X.Y.Z.
73 -s name:cvsbranch Create a snapshot, not a real release.
75 -d destination Local working directory where we will build the release
77 -f Create a final release (and update ChangeLogs,...).
78 -l Indicate that we are running on gcc.gnu.org.
79 -p previous-tarball Location of a previous tarball (to generate diff files).
80 -t tag Tag to mark the release in CVS.
81 -u username Username for upload operations.
86 # Change to the directory given by $1.
90 error "Could not change directory to $1"
93 # Each of the arguments is a directory name, relative to the top
94 # of the source tree. Return another name for that directory, relative
95 # to the working directory.
99 echo `basename ${SOURCE_DIRECTORY}`/$x
103 # Build the source tree that will be the basis for the release
104 # in ${WORKING_DIRECTORY}/gcc-${RELEASE}.
107 # If the WORKING_DIRECTORY already exists, do not risk destroying it.
108 if [ -r ${WORKING_DIRECTORY} ]; then
109 error "\`${WORKING_DIRECTORY}' already exists"
111 # Create the WORKING_DIRECTORY.
112 mkdir "${WORKING_DIRECTORY}" \
113 || error "Could not create \`${WORKING_DIRECTORY}'"
114 changedir "${WORKING_DIRECTORY}"
116 # If this is a final release, make sure that the ChangeLogs
117 # and version strings are updated.
118 if [ ${FINAL} -ne 0 ]; then
119 inform "Updating ChangeLogs and version files"
121 ${CVS} co -d "`basename ${SOURCE_DIRECTORY}`" \
122 -r ${CVSBRANCH} gcc || \
123 error "Could not check out release sources"
124 for x in `find ${SOURCE_DIRECTORY} -name ChangeLog`; do
125 # Update this ChangeLog file only if it does not yet contain the
126 # entry we are going to add. (This is a safety net for repeated
127 # runs of this script for the same release.)
128 if ! grep "GCC ${RELEASE} released." ${x} > /dev/null ; then
129 cat - ${x} > ${x}.new <<EOF
130 ${LONG_DATE} Release Manager
132 * GCC ${RELEASE} released.
135 mv ${x}.new ${x} || \
136 error "Could not update ${x}"
137 (changedir `dirname ${x}` && \
138 ${CVS} ci -m 'Mark ChangeLog' `basename ${x}`) || \
139 error "Could not commit ${x}"
143 # Update `gcc/version.c'.
144 for x in gcc/version.c; do
146 (changedir `dirname ${SOURCE_DIRECTORY}/${x}` && \
147 sed -e 's|= \".*\"|= \"'${RELEASE}'\"|g' < ${y} > ${y}.new && \
148 mv ${y}.new ${y} && \
149 ${CVS} ci -m 'Update version' ${y}) || \
150 error "Could not update ${x}"
153 # Make sure we tag the sources for a final release.
154 TAG="gcc_`echo ${RELEASE} | tr . _`_release"
156 rm -rf ${SOURCE_DIRECTORY}
160 if [ -n "${TAG}" ]; then
161 inform "Tagging sources as ${TAG}"
162 ${CVS} rtag -r ${CVSBRANCH} -F ${TAG} gcc || \
163 error "Could not tag sources"
167 # Export the current sources.
168 inform "Retrieving release sources"
170 export -d "`basename ${SOURCE_DIRECTORY}`" \
171 -r ${CVSBRANCH} gcc || \
172 error "Could not retrieve release sources"
174 # Run gcc_update on them to set up the timestamps nicely.
175 changedir "gcc-${RELEASE}"
176 contrib/gcc_update --touch
178 # Obtain some documentation files from the wwwdocs module.
179 inform "Retrieving HTML documentation"
180 changedir "${WORKING_DIRECTORY}"
181 for x in bugs faq; do
182 (${CVS} export -r HEAD wwwdocs/htdocs/${x}.html && \
183 cp ${WORKING_DIRECTORY}/wwwdocs/htdocs/${x}.html \
184 ${SOURCE_DIRECTORY}) || \
185 error "Could not retrieve ${x}.html"
188 inform "Generating plain-text documentation from HTML"
189 changedir "${SOURCE_DIRECTORY}"
190 for file in *.html; do
191 newfile=`echo $file | sed -e 's/.html//' | tr "[:lower:]" "[:upper:]"`
192 (${ENV} TERM=vt100 lynx -dump $file \
193 | sed -e "s#file://localhost`/bin/pwd`\(.*\)#http://gcc.gnu.org\1#g" \
195 error "Could not generate text-only version of ${file}"
198 # For a prerelease or real release, we need to generate additional
199 # files not present in CVS.
200 changedir "${SOURCE_DIRECTORY}"
201 if [ $SNAPSHOT -ne 1 ]; then
202 # Generate the documentation.
203 inform "Building install docs"
204 SOURCEDIR=${SOURCE_DIRECTORY}/gcc/doc
205 DESTDIR=${SOURCE_DIRECTORY}/INSTALL
208 ${SOURCE_DIRECTORY}/gcc/doc/install.texi2html
210 # Regenerate the NEWS file.
211 contrib/gennews > gcc/NEWS || \
212 error "Could not regenerate NEWS files"
214 # Now, we must build the compiler in order to create any generated
215 # files that are supposed to go in the source directory. This is
216 # also a good sanity check to make sure that the release builds
217 # on at least one platform.
218 inform "Building compiler"
219 OBJECT_DIRECTORY=../objdir
220 contrib/gcc_build -d ${SOURCE_DIRECTORY} -o ${OBJECT_DIRECTORY} build || \
221 error "Could not rebuild GCC"
223 # Regenerate the Fotran NEWS and BUGS files.
224 (cd ${OBJECT_DIRECTORY}/gcc && make f77.rebuilt) || \
225 error "Could not regenerate Fortran NEWS and BUGS files"
228 # Move message catalogs to source directory.
229 mv ../objdir/gcc/po/*.gmo gcc/po/
231 # Create a `.brik' file to use for checking the validity of the
233 changedir "${SOURCE_DIRECTORY}"
234 BRIK_FILE=`mktemp /tmp/gcc_release.XXXXXXX`
235 ((find . -type f | sort > $BRIK_FILE) && \
236 brik -Gb -f ${BRIK_FILE} > .brik && \
237 rm ${BRIK_FILE}) || \
238 error "Could not compute brik checksum"
241 # Buid a single tarfile. The first argument is the name of the name
242 # of the tarfile to build, without any suffixes. They will be added
243 # automatically. The rest of the arguments are the files or
244 # directories to include.
247 # Get the name of the destination tar file.
251 # Build the tar file itself.
252 (${TAR} cf - "$@" | ${BZIP2} > ${TARFILE}) || \
253 error "Could not build tarfile"
254 FILE_LIST="${FILE_LIST} ${TARFILE}"
257 # Build the various tar files for the release.
260 inform "Building tarfiles"
262 changedir "${WORKING_DIRECTORY}"
264 # The GNU Coding Standards specify that all files should
266 chmod -R a+r ${SOURCE_DIRECTORY}
267 # And that all directories have mode 777.
268 find ${SOURCE_DIRECTORY} -type d -exec chmod 777 {} \;
270 # Build one huge tarfile for the entire distribution.
271 build_tarfile gcc-${RELEASE} `basename ${SOURCE_DIRECTORY}`
273 # Now, build one for each of the languages.
274 build_tarfile gcc-ada-${RELEASE} ${ADA_DIRS}
275 build_tarfile gcc-g++-${RELEASE} ${CPLUSPLUS_DIRS}
276 build_tarfile gcc-g77-${RELEASE} ${FORTRAN_DIRS}
277 build_tarfile gcc-java-${RELEASE} ${JAVA_DIRS}
278 build_tarfile gcc-objc-${RELEASE} ${OBJECTIVEC_DIRS}
279 build_tarfile gcc-testsuite-${RELEASE} ${TESTSUITE_DIRS}
281 # The core is everything else.
283 for x in ${ADA_DIRS} ${CPLUSPLUS_DIRS} ${FORTRAN_DIRS} \
284 ${JAVA_DIRS} ${OBJECTIVEC_DIRS} ${TESTSUITE_DIRS}; do
285 EXCLUDES="${EXCLUDES} --exclude $x"
287 build_tarfile gcc-core-${RELEASE} ${EXCLUDES} \
288 `basename ${SOURCE_DIRECTORY}`
293 for f in ${FILE_LIST}; do
295 (${BZIP2} -d -c $f | ${GZIP} > ${target}) || error "Could not create ${target}"
299 # Build diffs against an old release.
303 old_vers=${old_file%.tar.bz2}
304 old_vers=${old_vers#gcc-}
305 inform "Building diffs against version $old_vers"
306 for f in gcc gcc-ada gcc-g++ gcc-g77 gcc-java gcc-objc gcc-testsuite gcc-core; do
307 old_tar=${old_dir}/${f}-${old_vers}.tar.bz2
308 new_tar=${WORKING_DIRECTORY}/${f}-${RELEASE}.tar.bz2
309 if [ ! -e $old_tar ]; then
310 inform "$old_tar not found; not generating diff file"
311 elif [ ! -e $new_tar ]; then
312 inform "$new_tar not found; not generating diff file"
314 build_diff $old_tar gcc-${old_vers} $new_tar gcc-${RELEASE} \
315 ${f}-${old_vers}-${RELEASE}.diff.bz2
320 # Build an individual diff.
322 changedir "${WORKING_DIRECTORY}"
324 mkdir $tmpdir || error "Could not create directory $tmpdir"
326 (${BZIP2} -d -c $1 | ${TAR} xf - ) || error "Could not unpack $1 for diffs"
327 (${BZIP2} -d -c $3 | ${TAR} xf - ) || error "Could not unpack $3 for diffs"
328 ${DIFF} $2 $4 > ../${5%.bz2}
329 if [ $? -eq 2 ]; then
330 error "Trouble making diffs from $1 to $3"
332 ${BZIP2} ../${5%.bz2} || error "Could not generate ../$5"
335 FILE_LIST="${FILE_LIST} $5"
338 # Upload the files to the FTP server.
340 inform "Uploading files"
342 changedir "${WORKING_DIRECTORY}"
344 # Make sure the directory exists on the server.
345 if [ $LOCAL -eq 0 ]; then
346 ${SSH} -l ${GCC_USERNAME} ${GCC_HOSTNAME} \
347 mkdir -p "${FTP_PATH}/diffs"
348 UPLOAD_PATH="${GCC_USERNAME}@${GCC_HOSTNAME}:${FTP_PATH}"
350 mkdir -p "${FTP_PATH}/diffs" \
351 || error "Could not create \`${FTP_PATH}'"
352 UPLOAD_PATH=${FTP_PATH}
355 # Then copy files to their respective (sub)directories.
356 for x in gcc*.gz gcc*.bz2; do
358 # Make sure the file will be readable on the server.
368 ${SCP} ${x} ${UPLOAD_PATH}/${SUBDIR} \
369 || error "Could not upload ${x}"
374 # Announce a snapshot, both on the web and via mail.
375 announce_snapshot() {
376 inform "Updating links and READMEs on the FTP server"
378 TEXT_DATE=`date --date=$DATE +%B\ %d,\ %Y`
379 cd ~ftp/pub/gcc/snapshots
380 sed -e "s%@DATE@%$DATE%g" \
381 -e "s%@LAST_DATE@%$LAST_DATE%g" \
382 -e "s%@BRANCH@%${BRANCH}%g" \
383 -e "s%@RELEASE@%${RELEASE}%g" \
384 -e "s%@TEXT_DATE@%$TEXT_DATE%g" < ~/scripts/snapshot-README > $$
385 mv $$ ${RELEASE}/README
386 sed -e "s%@DATE@%$DATE%g" \
387 -e "s%@LAST_DATE@%$LAST_DATE%g" \
388 -e "s%@BRANCH@%${BRANCH}%g" \
389 -e "s%@RELEASE@%${RELEASE}%g" \
390 -e "s%@TEXT_DATE@%$TEXT_DATE%g" < ~/scripts/snapshot-index.html > $$
391 mv $$ ${RELEASE}/index.html
393 touch LATEST-IS-${BRANCH}-${DATE}
394 rm -f LATEST-IS-${BRANCH}-${LAST_DATE}
396 inform "Sending mail"
398 export QMAILHOST=gcc.gnu.org
399 mail -s "gcc-ss-${RELEASE} is now available" gcc@gcc.gnu.org < ~ftp/pub/gcc/snapshots/${RELEASE}/README
402 ########################################################################
404 ########################################################################
407 DATE=`date "+%Y%m%d"`
408 LONG_DATE=`date "+%Y-%m-%d"`
410 # The CVS server containing the GCC repository.
411 CVS_SERVER="gcc.gnu.org"
412 # The path to the repository on that server.
413 CVS_REPOSITORY="/cvs/gcc"
414 # The CVS protocol to use.
416 # The username to use when connecting to the server.
417 CVS_USERNAME="${USER}"
419 # The machine to which files will be uploaded.
420 GCC_HOSTNAME="gcc.gnu.org"
421 # The name of the account on the machine to which files are uploaded.
422 GCC_USERNAME="gccadmin"
423 # The directory in which the files will be placed.
424 FTP_PATH="~ftp/pub/gcc"
426 # The major number for the release. For release `3.0.2' this would be
429 # The minor number for the release. For release `3.0.2' this would be
432 # The revision number for the release. For release `3.0.2' this would
435 # The complete name of the release.
438 # The name of the branch from which the release should be made, in a
439 # user-friendly form.
442 # The name of the branch from which the release should be made, as used
443 # for our version control system.
446 # The tag to apply to the sources used for the release.
449 # The old tarballs from which to generate diffs.
452 # The directory that will be used to construct the release. The
453 # release itself will be placed in a subdirectory of this diretory.
457 # The directory that will contain the GCC sources.
460 # The directories that should be part of the various language-specific
461 # tar files. These are all relative to the top of the source tree.
463 CPLUSPLUS_DIRS="gcc/cp libstdc++-v3"
464 FORTRAN_DIRS="gcc/f libf2c"
465 JAVA_DIRS="gcc/java libjava libffi fastjar zlib boehm-gc"
466 OBJECTIVEC_DIRS="gcc/objc libobjc"
467 TESTSUITE_DIRS="gcc/testsuite"
469 # Non-zero if this is the final release, rather than a prerelease.
472 # Non-zero if we are building a snapshot, and don't build gcc or
473 # include generated files.
476 # Non-zero if we are running locally on gcc.gnu.org, and use local CVS
477 # and copy directly to the FTP directory.
480 # Major operation modes.
487 # List of archive files generated; used to create .gz files from .bz2.
492 BZIP2="${BZIP2:-bzip2}"
493 CVS="${CVS:-cvs -f -Q -z9}"
494 DIFF="${DIFF:-diff -Nrc3pad}"
496 GZIP="${GZIP:-gzip --best}"
501 ########################################################################
502 # Command Line Processing
503 ########################################################################
506 while getopts "d:fr:u:t:p:s:l" ARG; do
508 d) DESTINATION="${OPTARG}";;
509 r) RELEASE="${OPTARG}";;
511 u) CVS_USERNAME="${OPTARG}";;
515 CVSBRANCH=${OPTARG#*:}
519 FTP_PATH=~ftp/pub/gcc
520 PATH=~:/usr/local/bin:$PATH;;
521 p) OLD_TARS="${OLD_TARS} ${OPTARG}"
522 if [ -d ${OPTARG} ]; then
523 error "-p argument must name a tarball"
528 shift `expr ${OPTIND} - 1`
530 # Handle the major modes.
531 while [ $# -ne 0 ]; do
533 diffs) MODE_DIFFS=1;;
535 sources) MODE_SOURCES=1;;
536 tarfiles) MODE_TARFILES=1;;
537 upload) MODE_UPLOAD=1;;
538 all) MODE_SOURCES=1; MODE_TARFILES=1; MODE_DIFFS=1; MODE_UPLOAD=1;
539 if [ $SNAPSHOT -ne 1 ]; then
540 # Only for releases and pre-releases.
544 *) error "Unknown mode $1";;
549 # Perform consistency checking.
550 if [ ${LOCAL} -eq 0 ] && [ -z ${CVS_USERNAME} ]; then
551 error "No username specified"
554 if [ ! -d ${DESTINATION} ]; then
555 error "\`${DESTINATION}' is not a directory"
558 if [ $SNAPSHOT -eq 0 ]; then
559 if [ -z ${RELEASE} ]; then
560 error "No release number specified"
563 # Compute the major and minor release numbers.
564 RELEASE_MAJOR=`echo $RELEASE | awk --assign FS=. '{ print $1; }'`
565 RELEASE_MINOR=`echo $RELEASE | awk --assign FS=. '{ print $2; }'`
566 RELEASE_REVISION=`echo $RELEASE | awk --assign FS=. '{ print $3; }'`
568 if [ -z "${RELEASE_MAJOR}" ] || [ -z "${RELEASE_MINOR}" ]; then
569 error "Release number \`${RELEASE}' is invalid"
572 # Compute the full name of the release.
573 if [ -z "${RELEASE_REVISION}" ]; then
574 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}"
576 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}.${RELEASE_REVISION}"
579 # Compute the name of the branch, which is based solely on the major
580 # and minor release numbers.
581 CVSBRANCH="gcc-${RELEASE_MAJOR}_${RELEASE_MINOR}-branch"
583 # If this is not a final release, set various parameters acordingly.
584 if [ ${FINAL} -ne 1 ]; then
585 RELEASE="${RELEASE}-${DATE}"
586 FTP_PATH="${FTP_PATH}/snapshots/"
588 FTP_PATH="${FTP_PATH}/releases/gcc-${RELEASE}/"
591 RELEASE=${BRANCH}-${DATE}
592 FTP_PATH="${FTP_PATH}/snapshots/${RELEASE}"
593 if [ ${CVSBRANCH} != "HEAD" ]; then
594 TAG=gcc-ss-`echo ${RELEASE} | tr '.' '_'`
597 # Building locally on gcc.gnu.org, we know what the last snapshot date
599 if [ $MODE_DIFFS -ne 0 ] && [ $LOCAL -ne 0 ]; then
600 LAST_DATE=`cat ~/.snapshot_date-${BRANCH}`
601 LAST_DIR=~ftp/pub/gcc/snapshots/${BRANCH}-${LAST_DATE}
602 OLD_TARS=${LAST_DIR}/gcc-${BRANCH}-${LAST_DATE}.tar.bz2
606 # Compute the name of the WORKING_DIRECTORY and the SOURCE_DIRECTORY.
607 WORKING_DIRECTORY="${DESTINATION}/gcc-${RELEASE}"
608 SOURCE_DIRECTORY="${WORKING_DIRECTORY}/gcc-${RELEASE}"
610 # Recompute the names of all the language-specific directories,
611 # relative to the WORKING_DIRECTORY.
612 ADA_DIRS=`adjust_dirs ${ADA_DIRS}`
613 CPLUSPLUS_DIRS=`adjust_dirs ${CPLUSPLUS_DIRS}`
614 FORTRAN_DIRS=`adjust_dirs ${FORTRAN_DIRS}`
615 JAVA_DIRS=`adjust_dirs ${JAVA_DIRS}`
616 OBJECTIVEC_DIRS=`adjust_dirs ${OBJECTIVEC_DIRS}`
617 TESTSUITE_DIRS=`adjust_dirs ${TESTSUITE_DIRS}`
620 if [ $LOCAL -eq 0 ]; then
621 CVSROOT=":${CVS_PROTOCOL}:${CVS_USERNAME}@"
622 CVSROOT="${CVSROOT}${CVS_SERVER}:${CVS_REPOSITORY}"
624 CVSROOT="${CVS_REPOSITORY}"
628 ########################################################################
630 ########################################################################
632 # Set the timezone to UTC
636 # Build the source directory.
638 if [ $MODE_SOURCES -ne 0 ]; then
642 # Build the tar files.
644 if [ $MODE_TARFILES -ne 0 ]; then
650 if [ $MODE_DIFFS -ne 0 ]; then
651 # Possibly build diffs.
652 if [ -n "$OLD_TARS" ]; then
653 for old_tar in $OLD_TARS; do
660 if [ $MODE_GZIP -ne 0 ]; then
664 # Upload them to the FTP server.
666 if [ $MODE_UPLOAD -ne 0 ]; then
669 # For snapshots, make some further updates.
670 if [ $SNAPSHOT -ne 0 ] && [ $LOCAL -ne 0 ]; then
673 # Update snapshot date file.
675 echo $DATE > .snapshot_date-${BRANCH}
677 # Remove working directory
678 rm -rf ${WORKING_DIRECTORY}