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
> gcc
/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 `.brik' file to use for checking the validity of the
254 changedir
"${SOURCE_DIRECTORY}"
255 BRIK_FILE
=`mktemp /tmp/gcc_release.XXXXXXX`
256 ((find .
-type f |
sort > $BRIK_FILE) && \
257 brik
-Gb -f ${BRIK_FILE} > .brik
&& \
258 rm ${BRIK_FILE}) || \
259 error
"Could not compute brik checksum"
262 # Buid a single tarfile. The first argument is the name of the name
263 # of the tarfile to build, without any suffixes. They will be added
264 # automatically. The rest of the arguments are the files or
265 # directories to include.
268 # Get the name of the destination tar file.
272 # Build the tar file itself.
273 (${TAR} cf - "$@" | ${BZIP2} > ${TARFILE}) || \
274 error
"Could not build tarfile"
275 FILE_LIST
="${FILE_LIST} ${TARFILE}"
278 # Build the various tar files for the release.
281 inform
"Building tarfiles"
283 changedir
"${WORKING_DIRECTORY}"
285 # The GNU Coding Standards specify that all files should
287 chmod -R a
+r
${SOURCE_DIRECTORY}
288 # And that all directories have mode 777.
289 find ${SOURCE_DIRECTORY} -type d
-exec chmod 777 {} \
;
291 # Build one huge tarfile for the entire distribution.
292 build_tarfile gcc-
${RELEASE} `basename ${SOURCE_DIRECTORY}`
294 # Now, build one for each of the languages.
295 build_tarfile gcc-ada-
${RELEASE} ${ADA_DIRS}
296 build_tarfile gcc-g
++-${RELEASE} ${CPLUSPLUS_DIRS}
297 build_tarfile gcc-g77-
${RELEASE} ${FORTRAN_DIRS}
298 build_tarfile gcc-java-
${RELEASE} ${JAVA_DIRS}
299 build_tarfile gcc-objc-
${RELEASE} ${OBJECTIVEC_DIRS}
300 build_tarfile gcc-testsuite-
${RELEASE} ${TESTSUITE_DIRS}
302 # The core is everything else.
304 for x
in ${ADA_DIRS} ${CPLUSPLUS_DIRS} ${FORTRAN_DIRS} \
305 ${JAVA_DIRS} ${OBJECTIVEC_DIRS} ${TESTSUITE_DIRS}; do
306 EXCLUDES
="${EXCLUDES} --exclude $x"
308 build_tarfile gcc-core-
${RELEASE} ${EXCLUDES} \
309 `basename ${SOURCE_DIRECTORY}`
314 for f
in ${FILE_LIST}; do
316 (${BZIP2} -d -c $f | ${GZIP} > ${target}) || error "Could not create ${target}"
320 # Build diffs against an old release.
324 old_vers=${old_file%.tar.bz2}
325 old_vers=${old_vers#gcc-}
326 inform "Building diffs against version
$old_vers"
327 for f in gcc gcc-ada gcc-g++ gcc-g77 gcc-java gcc-objc gcc-testsuite gcc-core; do
328 old_tar=${old_dir}/${f}-${old_vers}.tar.bz2
329 new_tar=${WORKING_DIRECTORY}/${f}-${RELEASE}.tar.bz2
330 if [ ! -e $old_tar ]; then
331 inform "$old_tar not found
; not generating
diff file"
332 elif [ ! -e $new_tar ]; then
333 inform "$new_tar not found
; not generating
diff file"
335 build_diff $old_tar gcc-${old_vers} $new_tar gcc-${RELEASE} \
336 ${f}-${old_vers}-${RELEASE}.diff.bz2
341 # Build an individual diff.
343 changedir "${WORKING_DIRECTORY}"
345 mkdir $tmpdir || error "Could not create directory
$tmpdir"
347 (${BZIP2} -d -c $1 | ${TAR} xf - ) || error "Could not unpack
$1 for diffs
"
348 (${BZIP2} -d -c $3 | ${TAR} xf - ) || error "Could not unpack
$3 for diffs
"
349 ${DIFF} $2 $4 > ../${5%.bz2}
350 if [ $? -eq 2 ]; then
351 error "Trouble making diffs from
$1 to
$3"
353 ${BZIP2} ../${5%.bz2} || error "Could not generate ..
/$5"
356 FILE_LIST="${FILE_LIST} $5"
359 # Upload the files to the FTP server.
361 inform "Uploading files
"
363 changedir "${WORKING_DIRECTORY}"
365 # Make sure the directory exists on the server.
366 if [ $LOCAL -eq 0 ]; then
367 ${SSH} -l ${GCC_USERNAME} ${GCC_HOSTNAME} \
368 mkdir -p "${FTP_PATH}/diffs
"
369 UPLOAD_PATH="${GCC_USERNAME}@${GCC_HOSTNAME}:${FTP_PATH}"
371 mkdir -p "${FTP_PATH}/diffs
" \
372 || error "Could not create \
`${FTP_PATH}'"
373 UPLOAD_PATH=${FTP_PATH}
376 # Then copy files to their respective (sub)directories.
377 for x in gcc*.gz gcc*.bz2; do
379 # Make sure the file will be readable on the server.
389 ${SCP} ${x} ${UPLOAD_PATH}/${SUBDIR} \
390 || error "Could not upload ${x}"
395 # Announce a snapshot, both on the web and via mail.
396 announce_snapshot() {
397 inform "Updating links and READMEs on the FTP server"
399 TEXT_DATE=`date --date=$DATE +%B\
%d
,\
%Y
`
400 changedir "${SNAPSHOTS_DIR}"
401 sed -e "s%@DATE@%$DATE%g" \
402 -e "s%@TEXT_DATE@%$TEXT_DATE%g" \
403 -e "s%@LAST_DATE@%$LAST_DATE%g" \
404 -e "s%@BRANCH@%${BRANCH}%g" \
405 -e "s%@RELEASE@%${RELEASE}%g" \
406 -e "s%@EXPORT@%${EXPORTTAG} ${EXPORTDATE}%g" \
407 ~/scripts/snapshot-README > $$
408 mv $$ ${RELEASE}/README
409 sed -e "s%@DATE@%$DATE%g" \
410 -e "s%@TEXT_DATE@%$TEXT_DATE%g" \
411 -e "s%@LAST_DATE@%$LAST_DATE%g" \
412 -e "s%@BRANCH@%${BRANCH}%g" \
413 -e "s%@RELEASE@%${RELEASE}%g" \
414 -e "s%@EXPORT@%${EXPORTTAG} ${EXPORTDATE}%g" \
415 ~/scripts/snapshot-index.html > $$
416 mv $$ ${RELEASE}/index.html
418 touch LATEST-IS-${BRANCH}-${DATE}
419 rm -f LATEST-IS-${BRANCH}-${LAST_DATE}
421 inform "Sending mail"
423 export QMAILHOST=gcc.gnu.org
424 mail -s "gcc-ss-${RELEASE} is now available" gcc@gcc.gnu.org < ${SNAPSHOTS_DIR}/${RELEASE}/README
427 ########################################################################
429 ########################################################################
432 DATE=`date "+%Y%m%d"`
433 LONG_DATE=`date "+%Y-%m-%d"`
435 # The CVS server containing the GCC repository.
436 CVS_SERVER="gcc.gnu.org"
437 # The path to the repository on that server.
438 CVS_REPOSITORY="/cvs/gcc"
439 # The CVS protocol to use.
441 # The username to use when connecting to the server.
442 CVS_USERNAME="${USER}"
444 # The machine to which files will be uploaded.
445 GCC_HOSTNAME="gcc.gnu.org"
446 # The name of the account on the machine to which files are uploaded.
447 GCC_USERNAME="gccadmin"
448 # The directory in which the files will be placed (do not use ~user syntax).
449 FTP_PATH=/var/ftp/pub/gcc
450 # The directory in which snapshots will be placed.
451 SNAPSHOTS_DIR=${FTP_PATH}/snapshots
453 # The major number for the release. For release `3.0.2' this would be
456 # The minor number for the release. For release `3.0.2' this would be
459 # The revision number for the release. For release `3.0.2' this would
462 # The complete name of the release.
465 # The name of the branch from which the release should be made, in a
466 # user-friendly form.
469 # The name of the branch from which the release should be made, as used
470 # for our version control system.
473 # The tag to apply to the sources used for the release.
476 # The old tarballs from which to generate diffs.
479 # The directory that will be used to construct the release. The
480 # release itself will be placed in a subdirectory of this diretory.
484 # The directory that will contain the GCC sources.
487 # The directories that should be part of the various language-specific
488 # tar files. These are all relative to the top of the source tree.
489 ADA_DIRS
="gcc/ada libada"
490 CPLUSPLUS_DIRS
="gcc/cp libstdc++-v3"
491 FORTRAN_DIRS
="gcc/f libf2c"
492 JAVA_DIRS
="gcc/java libjava libffi fastjar zlib boehm-gc"
493 OBJECTIVEC_DIRS
="gcc/objc libobjc"
494 TESTSUITE_DIRS
="gcc/testsuite"
496 # Non-zero if this is the final release, rather than a prerelease.
499 # Non-zero if we are building a snapshot, and don't build gcc or
500 # include generated files.
503 # Non-zero if we are running locally on gcc.gnu.org, and use local CVS
504 # and copy directly to the FTP directory.
507 # Major operation modes.
514 # List of archive files generated; used to create .gz files from .bz2.
519 BZIP2
="${BZIP2:-bzip2}"
520 CVS
="${CVS:-cvs -f -Q -z9}"
521 DIFF
="${DIFF:-diff -Nrc3pad}"
523 GZIP
="${GZIP:-gzip --best}"
528 ########################################################################
529 # Command Line Processing
530 ########################################################################
533 while getopts "d:fr:u:t:p:s:l" ARG
; do
535 d
) DESTINATION
="${OPTARG}";;
536 r
) RELEASE
="${OPTARG}";;
538 u
) CVS_USERNAME
="${OPTARG}";;
542 CVSBRANCH
=${OPTARG#*:}
546 PATH
=~
:/usr
/local
/bin
:$PATH;;
547 p
) OLD_TARS
="${OLD_TARS} ${OPTARG}"
548 if [ ! -f ${OPTARG} ]; then
549 error
"-p argument must name a tarball"
554 shift `expr ${OPTIND} - 1`
556 # Handle the major modes.
557 while [ $# -ne 0 ]; do
559 diffs
) MODE_DIFFS
=1;;
561 sources
) MODE_SOURCES
=1;;
562 tarfiles
) MODE_TARFILES
=1;;
563 upload
) MODE_UPLOAD
=1;;
564 all
) MODE_SOURCES
=1; MODE_TARFILES
=1; MODE_DIFFS
=1; MODE_UPLOAD
=1;
565 if [ $SNAPSHOT -ne 1 ]; then
566 # Only for releases and pre-releases.
570 *) error
"Unknown mode $1";;
575 # Perform consistency checking.
576 if [ ${LOCAL} -eq 0 ] && [ -z ${CVS_USERNAME} ]; then
577 error
"No username specified"
580 if [ ! -d ${DESTINATION} ]; then
581 error
"\`${DESTINATION}' is not a directory"
584 if [ $SNAPSHOT -eq 0 ]; then
585 if [ -z ${RELEASE} ]; then
586 error
"No release number specified"
589 # Compute the major and minor release numbers.
590 RELEASE_MAJOR
=`echo $RELEASE | awk --assign FS=. '{ print $1; }'`
591 RELEASE_MINOR
=`echo $RELEASE | awk --assign FS=. '{ print $2; }'`
592 RELEASE_REVISION
=`echo $RELEASE | awk --assign FS=. '{ print $3; }'`
594 if [ -z "${RELEASE_MAJOR}" ] ||
[ -z "${RELEASE_MINOR}" ]; then
595 error
"Release number \`${RELEASE}' is invalid"
598 # Compute the full name of the release.
599 if [ -z "${RELEASE_REVISION}" ]; then
600 RELEASE
="${RELEASE_MAJOR}.${RELEASE_MINOR}"
602 RELEASE
="${RELEASE_MAJOR}.${RELEASE_MINOR}.${RELEASE_REVISION}"
605 # Compute the name of the branch, which is based solely on the major
606 # and minor release numbers.
607 CVSBRANCH
="gcc-${RELEASE_MAJOR}_${RELEASE_MINOR}-branch"
609 # If this is not a final release, set various parameters acordingly.
610 if [ ${FINAL} -ne 1 ]; then
611 RELEASE
="${RELEASE}-${DATE}"
612 FTP_PATH
="${FTP_PATH}/prerelease-${RELEASE}/"
614 FTP_PATH
="${FTP_PATH}/releases/gcc-${RELEASE}/"
617 RELEASE
=${BRANCH}-${DATE}
618 FTP_PATH
="${FTP_PATH}/snapshots/${RELEASE}"
619 if [ ${CVSBRANCH} != "HEAD" ]; then
620 TAG
=gcc-ss-
`echo ${RELEASE} | tr '.' '_'`
623 # If diffs are requested when building locally on gcc.gnu.org, we (usually)
624 # know what the last snapshot date was and take the corresponding tarballs,
625 # unless the user specified tarballs explictly.
626 if [ $MODE_DIFFS -ne 0 ] && [ $LOCAL -ne 0 ] && [ -z "${OLD_TARS}" ]; then
627 LAST_DATE
=`cat ~/.snapshot_date-${BRANCH}`
628 OLD_TARS
=${SNAPSHOTS_DIR}/${BRANCH}-${LAST_DATE}/gcc-${BRANCH}-${LAST_DATE}.
tar.bz2
632 # Compute the name of the WORKING_DIRECTORY and the SOURCE_DIRECTORY.
633 WORKING_DIRECTORY
="${DESTINATION}/gcc-${RELEASE}"
634 SOURCE_DIRECTORY
="${WORKING_DIRECTORY}/gcc-${RELEASE}"
636 # Recompute the names of all the language-specific directories,
637 # relative to the WORKING_DIRECTORY.
638 ADA_DIRS
=`adjust_dirs ${ADA_DIRS}`
639 CPLUSPLUS_DIRS
=`adjust_dirs ${CPLUSPLUS_DIRS}`
640 FORTRAN_DIRS
=`adjust_dirs ${FORTRAN_DIRS}`
641 JAVA_DIRS
=`adjust_dirs ${JAVA_DIRS}`
642 OBJECTIVEC_DIRS
=`adjust_dirs ${OBJECTIVEC_DIRS}`
643 TESTSUITE_DIRS
=`adjust_dirs ${TESTSUITE_DIRS}`
646 if [ $LOCAL -eq 0 ]; then
647 CVSROOT
=":${CVS_PROTOCOL}:${CVS_USERNAME}@"
648 CVSROOT
="${CVSROOT}${CVS_SERVER}:${CVS_REPOSITORY}"
650 CVSROOT
="${CVS_REPOSITORY}"
654 ########################################################################
656 ########################################################################
658 # Set the timezone to UTC
662 # Build the source directory.
664 if [ $MODE_SOURCES -ne 0 ]; then
668 # Build the tar files.
670 if [ $MODE_TARFILES -ne 0 ]; then
676 if [ $MODE_DIFFS -ne 0 ]; then
677 # Possibly build diffs.
678 if [ -n "$OLD_TARS" ]; then
679 for old_tar
in $OLD_TARS; do
686 if [ $MODE_GZIP -ne 0 ]; then
690 # Upload them to the FTP server.
692 if [ $MODE_UPLOAD -ne 0 ]; then
695 # For snapshots, make some further updates.
696 if [ $SNAPSHOT -ne 0 ] && [ $LOCAL -ne 0 ]; then
699 # Update snapshot date file.
701 echo $DATE > .snapshot_date-
${BRANCH}
703 # Remove working directory
704 rm -rf ${WORKING_DIRECTORY}