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|version_string\[\] = \".*\"|version_string\[\] = \"'${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}
161 if [ -n "${TAG}" ]; then
162 inform "Tagging sources as ${TAG}"
163 # The -F option to CVS is intentionally not used below. If you
164 # need to retry a release, you will have to manually remove any
166 ${CVS} rtag -r ${CVSBRANCH} ${TAG} gcc || \
167 error "Could not tag sources"
170 if [ ${CVSBRANCH} != "HEAD" ]; then
171 EXPORTTAG="-r${CVSBRANCH}"
172 # It does not work to use both "-r" and "-D" with
173 # "cvs export" so EXPORTDATE is not set here.
175 # HEAD is the default branch, no need to specify it.
177 EXPORTDATE="-D`date -u +"%Y-%m-%d %H:%M"` UTC"
181 # Export the current sources.
182 inform "Retrieving sources (cvs export ${EXPORTTAG} ${EXPORTDATE} gcc)"
184 if [ -z "${EXPORTTAG}" ]; then
185 ${CVS} export -d "`basename ${SOURCE_DIRECTORY}`" \
186 "${EXPORTDATE}" gcc || \
187 error "Could not retrieve sources"
188 elif [ -z "${EXPORTDATE}" ]; then
189 ${CVS} export -d "`basename ${SOURCE_DIRECTORY}`" \
190 "${EXPORTTAG}" gcc || \
191 error "Could not retrieve sources"
193 error "Cannot specify -r and -D at the same time"
196 # Run gcc_update on them to set up the timestamps nicely, and (re)write
197 # the LAST_UPDATED file containing the CVS tag/date used.
198 changedir "gcc-${RELEASE}"
199 contrib/gcc_update --touch
200 echo "Obtained from CVS: ${EXPORTTAG} ${EXPORTDATE}" > LAST_UPDATED
202 # Obtain some documentation files from the wwwdocs module.
203 inform "Retrieving HTML documentation"
204 changedir "${WORKING_DIRECTORY}"
205 for x in bugs faq; do
206 (${CVS} export -r HEAD wwwdocs/htdocs/${x}.html && \
207 cp ${WORKING_DIRECTORY}/wwwdocs/htdocs/${x}.html \
208 ${SOURCE_DIRECTORY}) || \
209 error "Could not retrieve ${x}.html"
212 inform "Generating plain-text documentation from HTML"
213 changedir "${SOURCE_DIRECTORY}"
214 for file in *.html; do
215 newfile=`echo $file | sed -e 's/.html//' | tr "[:lower:]" "[:upper:]"`
216 (${ENV} TERM=vt100 lynx -dump $file \
217 | sed -e "s#file://localhost`/bin/pwd`\(.*\)#http://gcc.gnu.org\1#g" \
219 error "Could not generate text-only version of ${file}"
222 # For a prerelease or real release, we need to generate additional
223 # files not present in CVS.
224 changedir "${SOURCE_DIRECTORY}"
225 if [ $SNAPSHOT -ne 1 ]; then
226 # Generate the documentation.
227 inform "Building install docs"
228 SOURCEDIR=${SOURCE_DIRECTORY}/gcc/doc
229 DESTDIR=${SOURCE_DIRECTORY}/INSTALL
232 ${SOURCE_DIRECTORY}/gcc/doc/install.texi2html
234 # Regenerate the NEWS file.
235 contrib/gennews > NEWS || \
236 error "Could not regenerate NEWS files"
238 # Now, we must build the compiler in order to create any generated
239 # files that are supposed to go in the source directory. This is
240 # also a good sanity check to make sure that the release builds
241 # on at least one platform.
242 inform "Building compiler"
243 OBJECT_DIRECTORY=../objdir
244 contrib/gcc_build -d ${SOURCE_DIRECTORY} -o ${OBJECT_DIRECTORY} \
245 -c "--enable-generated-files-in-srcdir" build || \
246 error "Could not rebuild GCC"
249 # Move message catalogs to source directory.
250 mv ../objdir/gcc/po/*.gmo gcc/po/
252 # Create a "MD5SUMS" file to use for checking the validity of the release.
253 find . -type f |sed -e 's:^\./::' -e '/MD5SUMS/d' |sort |xargs md5sum >MD5SUMS
256 # Buid a single tarfile. The first argument is the name of the name
257 # of the tarfile to build, without any suffixes. They will be added
258 # automatically. The rest of the arguments are the files or
259 # directories to include, and possibly other arguments to tar.
262 # Get the name of the destination tar file.
266 # Build the tar file itself.
267 (${TAR} cf - "$@" | ${BZIP2} > ${TARFILE}) || \
268 error "Could not build tarfile"
269 FILE_LIST="${FILE_LIST} ${TARFILE}"
272 # Build a single tarfile if any of the directories listed exist,
273 # but not if none of them do (because that component doesn't exist
275 maybe_build_tarfile() {
279 for maybe_dir in "$@"; do
280 if [ -d "$maybe_dir" ]; then
284 if [ $dir_exists = 1 ]; then
285 build_tarfile "$dest" "$@"
287 echo "Not building $dest tarfile"
291 # Build the various tar files for the release.
294 inform "Building tarfiles"
296 changedir "${WORKING_DIRECTORY}"
298 # The GNU Coding Standards specify that all files should
300 chmod -R a+r ${SOURCE_DIRECTORY}
301 # And that all directories have mode 777.
302 find ${SOURCE_DIRECTORY} -type d -exec chmod 777 {} \;
304 # Build one huge tarfile for the entire distribution.
305 build_tarfile gcc-${RELEASE} `basename ${SOURCE_DIRECTORY}`
307 # Now, build one for each of the languages.
308 maybe_build_tarfile gcc-ada-${RELEASE} ${ADA_DIRS}
309 maybe_build_tarfile gcc-g++-${RELEASE} ${CPLUSPLUS_DIRS}
310 maybe_build_tarfile gcc-g77-${RELEASE} ${FORTRAN_DIRS}
311 maybe_build_tarfile gcc-fortran-${RELEASE} ${FORTRAN95_DIRS}
312 maybe_build_tarfile gcc-java-${RELEASE} ${JAVA_DIRS}
313 maybe_build_tarfile gcc-objc-${RELEASE} ${OBJECTIVEC_DIRS}
314 maybe_build_tarfile gcc-testsuite-${RELEASE} ${TESTSUITE_DIRS}
316 # The core is everything else.
318 for x in ${ADA_DIRS} ${CPLUSPLUS_DIRS} ${FORTRAN_DIRS} ${FORTRAN95_DIRS}\
319 ${JAVA_DIRS} ${OBJECTIVEC_DIRS} ${TESTSUITE_DIRS}; do
320 EXCLUDES="${EXCLUDES} --exclude $x"
322 build_tarfile gcc-core-${RELEASE} ${EXCLUDES} \
323 `basename ${SOURCE_DIRECTORY}`
328 for f in ${FILE_LIST}; do
330 (${BZIP2} -d -c $f | ${GZIP} > ${target}) || error "Could not create ${target}"
334 # Build diffs against an old release.
338 old_vers=${old_file%.tar.bz2}
339 old_vers=${old_vers#gcc-}
340 inform "Building diffs against version $old_vers"
341 for f in gcc gcc-ada gcc-g++ gcc-g77 gcc-fortran gcc-java gcc-objc gcc-testsuite gcc-core; do
342 old_tar=${old_dir}/${f}-${old_vers}.tar.bz2
343 new_tar=${WORKING_DIRECTORY}/${f}-${RELEASE}.tar.bz2
344 if [ ! -e $old_tar ]; then
345 inform "$old_tar not found; not generating diff file"
346 elif [ ! -e $new_tar ]; then
347 inform "$new_tar not found; not generating diff file"
349 build_diff $old_tar gcc-${old_vers} $new_tar gcc-${RELEASE} \
350 ${f}-${old_vers}-${RELEASE}.diff.bz2
355 # Build an individual diff.
357 changedir "${WORKING_DIRECTORY}"
359 mkdir $tmpdir || error "Could not create directory $tmpdir"
361 (${BZIP2} -d -c $1 | ${TAR} xf - ) || error "Could not unpack $1 for diffs"
362 (${BZIP2} -d -c $3 | ${TAR} xf - ) || error "Could not unpack $3 for diffs"
363 ${DIFF} $2 $4 > ../${5%.bz2}
364 if [ $? -eq 2 ]; then
365 error "Trouble making diffs from $1 to $3"
367 ${BZIP2} ../${5%.bz2} || error "Could not generate ../$5"
370 FILE_LIST="${FILE_LIST} $5"
373 # Upload the files to the FTP server.
375 inform "Uploading files"
377 changedir "${WORKING_DIRECTORY}"
379 # Make sure the directory exists on the server.
380 if [ $LOCAL -eq 0 ]; then
381 ${SSH} -l ${GCC_USERNAME} ${GCC_HOSTNAME} \
382 mkdir -p "${FTP_PATH}/diffs"
383 UPLOAD_PATH="${GCC_USERNAME}@${GCC_HOSTNAME}:${FTP_PATH}"
385 mkdir -p "${FTP_PATH}/diffs" \
386 || error "Could not create \`${FTP_PATH}'"
387 UPLOAD_PATH=${FTP_PATH}
390 # Then copy files to their respective (sub)directories.
391 for x in gcc*.gz gcc*.bz2; do
393 # Make sure the file will be readable on the server.
403 ${SCP} ${x} ${UPLOAD_PATH}/${SUBDIR} \
404 || error "Could not upload ${x}"
409 # Announce a snapshot, both on the web and via mail.
410 announce_snapshot() {
411 inform "Updating links and READMEs on the FTP server"
413 TEXT_DATE=`date --date=$DATE +%B\ %d,\ %Y`
414 changedir "${SNAPSHOTS_DIR}"
415 sed -e "s%@DATE@%$DATE%g" \
416 -e "s%@TEXT_DATE@%$TEXT_DATE%g" \
417 -e "s%@LAST_DATE@%$LAST_DATE%g" \
418 -e "s%@BRANCH@%${BRANCH}%g" \
419 -e "s%@RELEASE@%${RELEASE}%g" \
420 -e "s%@EXPORT@%${EXPORTTAG} ${EXPORTDATE}%g" \
421 ~/scripts/snapshot-README > $$
422 mv $$ ${RELEASE}/README
423 sed -e "s%@DATE@%$DATE%g" \
424 -e "s%@TEXT_DATE@%$TEXT_DATE%g" \
425 -e "s%@LAST_DATE@%$LAST_DATE%g" \
426 -e "s%@BRANCH@%${BRANCH}%g" \
427 -e "s%@RELEASE@%${RELEASE}%g" \
428 -e "s%@EXPORT@%${EXPORTTAG} ${EXPORTDATE}%g" \
429 ~/scripts/snapshot-index.html > $$
430 mv $$ ${RELEASE}/index.html
432 touch LATEST-IS-${BRANCH}-${DATE}
433 rm -f LATEST-IS-${BRANCH}-${LAST_DATE}
435 inform "Sending mail"
437 export QMAILHOST=gcc.gnu.org
438 mail -s "gcc-ss-${RELEASE} is now available" gcc@gcc.gnu.org < ${SNAPSHOTS_DIR}/${RELEASE}/README
441 ########################################################################
443 ########################################################################
446 DATE=`date "+%Y%m%d"`
447 LONG_DATE=`date "+%Y-%m-%d"`
449 # The CVS server containing the GCC repository.
450 CVS_SERVER="gcc.gnu.org"
451 # The path to the repository on that server.
452 CVS_REPOSITORY="/cvs/gcc"
453 # The CVS protocol to use.
455 # The username to use when connecting to the server.
456 CVS_USERNAME="${USER}"
458 # The machine to which files will be uploaded.
459 GCC_HOSTNAME="gcc.gnu.org"
460 # The name of the account on the machine to which files are uploaded.
461 GCC_USERNAME="gccadmin"
462 # The directory in which the files will be placed (do not use ~user syntax).
463 FTP_PATH=/var/ftp/pub/gcc
464 # The directory in which snapshots will be placed.
465 SNAPSHOTS_DIR=${FTP_PATH}/snapshots
467 # The major number for the release. For release `3.0.2' this would be
470 # The minor number for the release. For release `3.0.2' this would be
473 # The revision number for the release. For release `3.0.2' this would
476 # The complete name of the release.
479 # The name of the branch from which the release should be made, in a
480 # user-friendly form.
483 # The name of the branch from which the release should be made, as used
484 # for our version control system.
487 # The tag to apply to the sources used for the release.
490 # The old tarballs from which to generate diffs.
493 # The directory that will be used to construct the release. The
494 # release itself will be placed in a subdirectory of this diretory.
498 # The directory that will contain the GCC sources.
501 # The directories that should be part of the various language-specific
502 # tar files. These are all relative to the top of the source tree.
503 ADA_DIRS="gcc/ada libada"
504 CPLUSPLUS_DIRS="gcc/cp libstdc++-v3"
505 FORTRAN_DIRS="gcc/f libf2c"
506 FORTRAN95_DIRS="gcc/fortran libgfortran"
507 JAVA_DIRS="gcc/java libjava libffi fastjar zlib boehm-gc"
508 OBJECTIVEC_DIRS="gcc/objc libobjc"
509 TESTSUITE_DIRS="gcc/testsuite"
511 # Non-zero if this is the final release, rather than a prerelease.
514 # Non-zero if we are building a snapshot, and don't build gcc or
515 # include generated files.
518 # Non-zero if we are running locally on gcc.gnu.org, and use local CVS
519 # and copy directly to the FTP directory.
522 # Major operation modes.
529 # List of archive files generated; used to create .gz files from .bz2.
534 BZIP2="${BZIP2:-bzip2}"
535 CVS="${CVS:-cvs -f -Q -z9}"
536 DIFF="${DIFF:-diff -Nrcpad}"
538 GZIP="${GZIP:-gzip --best}"
543 ########################################################################
544 # Command Line Processing
545 ########################################################################
548 while getopts "d:fr:u:t:p:s:l" ARG; do
550 d) DESTINATION="${OPTARG}";;
551 r) RELEASE="${OPTARG}";;
553 u) CVS_USERNAME="${OPTARG}";;
557 CVSBRANCH=${OPTARG#*:}
561 PATH=~:/usr/local/bin:$PATH;;
562 p) OLD_TARS="${OLD_TARS} ${OPTARG}"
563 if [ ! -f ${OPTARG} ]; then
564 error "-p argument must name a tarball"
569 shift `expr ${OPTIND} - 1`
571 # Handle the major modes.
572 while [ $# -ne 0 ]; do
574 diffs) MODE_DIFFS=1;;
576 sources) MODE_SOURCES=1;;
577 tarfiles) MODE_TARFILES=1;;
578 upload) MODE_UPLOAD=1;;
579 all) MODE_SOURCES=1; MODE_TARFILES=1; MODE_DIFFS=1; MODE_UPLOAD=1;
580 if [ $SNAPSHOT -ne 1 ]; then
581 # Only for releases and pre-releases.
585 *) error "Unknown mode $1";;
590 # Perform consistency checking.
591 if [ ${LOCAL} -eq 0 ] && [ -z ${CVS_USERNAME} ]; then
592 error "No username specified"
595 if [ ! -d ${DESTINATION} ]; then
596 error "\`${DESTINATION}' is not a directory"
599 if [ $SNAPSHOT -eq 0 ]; then
600 if [ -z ${RELEASE} ]; then
601 error "No release number specified"
604 # Compute the major and minor release numbers.
605 RELEASE_MAJOR=`echo $RELEASE | awk --assign FS=. '{ print $1; }'`
606 RELEASE_MINOR=`echo $RELEASE | awk --assign FS=. '{ print $2; }'`
607 RELEASE_REVISION=`echo $RELEASE | awk --assign FS=. '{ print $3; }'`
609 if [ -z "${RELEASE_MAJOR}" ] || [ -z "${RELEASE_MINOR}" ]; then
610 error "Release number \`${RELEASE}' is invalid"
613 # Compute the full name of the release.
614 if [ -z "${RELEASE_REVISION}" ]; then
615 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}"
617 RELEASE="${RELEASE_MAJOR}.${RELEASE_MINOR}.${RELEASE_REVISION}"
620 # Compute the name of the branch, which is based solely on the major
621 # and minor release numbers.
622 CVSBRANCH="gcc-${RELEASE_MAJOR}_${RELEASE_MINOR}-branch"
624 # If this is not a final release, set various parameters acordingly.
625 if [ ${FINAL} -ne 1 ]; then
626 RELEASE="${RELEASE}-${DATE}"
627 FTP_PATH="${FTP_PATH}/prerelease-${RELEASE}/"
629 FTP_PATH="${FTP_PATH}/releases/gcc-${RELEASE}/"
632 RELEASE=${BRANCH}-${DATE}
633 FTP_PATH="${FTP_PATH}/snapshots/${RELEASE}"
634 if [ ${CVSBRANCH} != "HEAD" ]; then
635 TAG=gcc-ss-`echo ${RELEASE} | tr '.' '_'`
638 # If diffs are requested when building locally on gcc.gnu.org, we (usually)
639 # know what the last snapshot date was and take the corresponding tarballs,
640 # unless the user specified tarballs explictly.
641 if [ $MODE_DIFFS -ne 0 ] && [ $LOCAL -ne 0 ] && [ -z "${OLD_TARS}" ]; then
642 LAST_DATE=`cat ~/.snapshot_date-${BRANCH}`
643 OLD_TARS=${SNAPSHOTS_DIR}/${BRANCH}-${LAST_DATE}/gcc-${BRANCH}-${LAST_DATE}.tar.bz2
647 # Compute the name of the WORKING_DIRECTORY and the SOURCE_DIRECTORY.
648 WORKING_DIRECTORY="${DESTINATION}/gcc-${RELEASE}"
649 SOURCE_DIRECTORY="${WORKING_DIRECTORY}/gcc-${RELEASE}"
651 # Recompute the names of all the language-specific directories,
652 # relative to the WORKING_DIRECTORY.
653 ADA_DIRS=`adjust_dirs ${ADA_DIRS}`
654 CPLUSPLUS_DIRS=`adjust_dirs ${CPLUSPLUS_DIRS}`
655 FORTRAN_DIRS=`adjust_dirs ${FORTRAN_DIRS}`
656 FORTRAN95_DIRS=`adjust_dirs ${FORTRAN95_DIRS}`
657 JAVA_DIRS=`adjust_dirs ${JAVA_DIRS}`
658 OBJECTIVEC_DIRS=`adjust_dirs ${OBJECTIVEC_DIRS}`
659 TESTSUITE_DIRS=`adjust_dirs ${TESTSUITE_DIRS}`
662 if [ $LOCAL -eq 0 ]; then
663 CVSROOT=":${CVS_PROTOCOL}:${CVS_USERNAME}@"
664 CVSROOT="${CVSROOT}${CVS_SERVER}:${CVS_REPOSITORY}"
666 CVSROOT="${CVS_REPOSITORY}"
670 ########################################################################
672 ########################################################################
674 # Set the timezone to UTC
678 # Build the source directory.
680 if [ $MODE_SOURCES -ne 0 ]; then
684 # Build the tar files.
686 if [ $MODE_TARFILES -ne 0 ]; then
692 if [ $MODE_DIFFS -ne 0 ]; then
693 # Possibly build diffs.
694 if [ -n "$OLD_TARS" ]; then
695 for old_tar in $OLD_TARS; do
702 if [ $MODE_GZIP -ne 0 ]; then
706 # Upload them to the FTP server.
708 if [ $MODE_UPLOAD -ne 0 ]; then
711 # For snapshots, make some further updates.
712 if [ $SNAPSHOT -ne 0 ] && [ $LOCAL -ne 0 ]; then
715 # Update snapshot date file.
717 echo $DATE > .snapshot_date-${BRANCH}
719 # Remove working directory
720 rm -rf ${WORKING_DIRECTORY}