path: root/lib/release.sh

#!/bin/bash
# 
#   Copyright (C) 2013, 2014, 2015, 2016 Linaro, Inc
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# 

#
# This makes a a release tarball Linaro style. Note that this does NOT
# test building the soure, nor do it run any tests. it just packages
# everything necesary for the release.
#

# Regenerate the MD5SUMS file
regenerate_checksums()
{
#    trace "$*"

    local reldir=$1

    local tag="$(basename $1)"

    cat <<EOF > ${reldir}/MD5SUMS
# This file contains the MD5 checksums of the files in the 
# ${tag}.tar.xz tarball.
#
# Besides verifying that all files in the tarball were correctly expanded,
# it also can be used to determine if any files have changed since the
# tarball was expanded or to verify that a patchfile was correctly applied.
#
# Suggested usage:
# md5sum -c MD5SUMS | grep -v "OK$"
EOF

    find ${reldir}/ -type f | grep -v MD5SUMS | LC_ALL=C sort > /tmp/md5sums.$$
    xargs md5sum < /tmp/md5sums.$$ 2>&1 | grep -v "\.git" | sed -e "s:${reldir}/::" >> ${reldir}/MD5SUMS
    rm -f /tmp/md5sums.$$

#    for i in $(cat /tmp/md5sums); do
#	md5sum $i 2>&1 | sed -e 's:/tmp/::' >> ${reldir}/MD5SUMS
#    done
    return 0
}

# GPG sign the tarball
sign_tarball()
{
#    trace "$*"

#    ssh -t abe@toolchain64 gpg --no-use-agent -q --yes --passphrase-file /home/abe/.config/abe/password --armor --sign --detach-sig --default-key abe "/home/abe/var/snapshots/gcc-linaro-${release}.tar.xz" scp abe@toolchain64:/home/abe/var/snapshots/gcc-linaro-${release}.tar.xz.asc $REL_DIR

    return 0
}

release_binutils_src()
{
    # See if specific component versions were specified at runtime
    if test x"${binutils_version}" = x; then
	local binutils_version="$(grep ^latest= ${topdir}/config/binutils.conf | cut -d '\"' -f 2) | tr -d '\"'"
    fi

    local srcdir="$(get_component_srcdir ${binutils_version})"
    local builddir="$(get_component_builddir ${binutils_version})-binutils"
    # The new combined repository for binutils has GDB too, so we strip that off.
    local tag="$(create_release_tag ${binutils_version} | sed -e 's:-gdb::' -e 's:-binutils::')"

    dryrun "mkdir -p /tmp/linaro.$$"
    local destdir="/tmp/linaro.$$/${tag}"

    # make a link with the correct name for the tarball's source directory
    dryrun "ln -sfnT ${srcdir} ${destdir}"

    # Update the Binutils version
    if test x"${release}" = x;then
	edit_changelogs ${destdir}/binutils ${tag}
    else
	edit_changelogs ${destdir}/binutils ${release}
    fi    

    # Create .gmo files from .po files.
    for i in $(find ${srcdir} -name '*.po' -type f -print); do
        dryrun "msgfmt -o $(echo $i | sed -e 's/\.po$/.gmo/') $i"
    done

    # Copy all the info files and man pages into the release directory
    local docs="$(find ${builddir}/ -name \*.info -o -name \*.1 -o -name \*.7 | sed -e "s:${builddir}/::")"
    for i in ${docs}; do
      	dryrun "cp -f ${builddir}/$i ${destdir}/$i"
    done

    dryrun "regenerate_checksums ${destdir}"

    # Remove extra files left over from any development hacking
    sanitize ${srcdir}

    local exclude="--exclude-vcs --exclude .gitignore --exclude .cvsignore --exclude .libs --exclude ${target}"
    dryrun "tar Jcfh ${local_snapshots}/${tag}.tar.xz ${exclude} --directory=/tmp/linaro.$$ ${tag}/"

    # Make the md5sum file for this tarball
    rm -f ${local_snapshots}/${tag}.tar.xz.asc
    dryrun "md5sum ${local_snapshots}/${tag}.tar.xz > ${local_snapshots}/${tag}.tar.xz.asc"

    return 0
}

# From: https://wiki.linaro.org/WorkingGroups/ToolChain/GCC/ReleaseProcess
# The output file name looks like this: gcc-linaro-4.8-2013.11.tar.xz.
# The date is set by the --release option to Abe. This function is
# only called with --tarsrc or --tarball.
release_gcc_src()
{
#    trace "$*"

    # See if specific component versions were specified at runtime
    if test x"${gcc_version}" = x; then
	local gcc_version="$(grep ^latest= ${topdir}/config/gcc.conf | cut -d '\"' -f 2) | tr -d '\"'"
    fi
    local srcdir="$(get_component_srcdir ${gcc_version})"
    local builddir="$(get_component_builddir ${gcc_version})-stage2"
    local tag="$(create_release_tag ${gcc_version} | sed -e 's:[-~]linaro-::' | tr '~' '-')"
    local destdir="${local_builds}/linaro.$$/${tag}"

    dryrun "mkdir -p ${local_builds}/linaro.$$"
    dryrun "ln -sfnT ${srcdir} ${destdir}"

    if test -d ${destdir}; then
	if test x"${release}" = x;then
	    edit_changelogs ${destdir}/gcc ${tag}
	else
	    edit_changelogs ${destdir}/gcc ${release}
	fi    
        # Remove extra files left over from any development hacking
	sanitize ${destdir}
    fi

    dryrun "regenerate_checksums ${destdir}"

    # Install the docs
    install_gcc_docs ${destdir} ${builddir} 

    local exclude="--exclude-vcs --exclude .gitignore --exclude .cvsignore --exclude .libs"
    dryrun "tar Jcfh ${local_snapshots}/${tag}.tar.xz ${exclude} --directory=/tmp/linaro.$$ ${tag}"

    # Make the md5sum file for this tarball
    rm -f ${local_snapshots}/${tag}.tar.xz.asc
    dryrun "md5sum ${local_snapshots}/${tag}.tar.xz > ${local_snapshots}/${tag}.tar.xz.asc"

    # Clean up doc files created during the build
    rm -fr ${destdir}/INSTALL ${destdir}/MD5SUMS ${destdir}/gcc/doc/*.1  ${destdir}/gcc/doc/*.7

    rm -fr ${local_builds}/linaro.$$
    return 0
}

# At release time, we build additional docs. We do this after the main GCC
# sources have been tarred, and append these to the tarball to avoid contaminating
# the source directory.
# $1 - 
install_gcc_docs()
{
#    trace "$*"

    local destdir=$1
    local srcdir=$1
    local builddir=$2

    # the GCC script needs these two values to work.
    SOURCEDIR=${srcdir}/gcc/doc
    DESTDIR=${destdir}/INSTALL
    dryrun ". ${srcdir}/gcc/doc/install.texi2html"

    # Create .gmo files from .po files.
    for i in $(find ${destdir} -name '*.po' -type f -print); do
        dryrun "msgfmt -o $(echo $i | sed -e 's/\.po$/.gmo/') $i"
    done

    # Make a man alias instead of copying the entire man page for G++
    if test ! -e ${builddir}/g++.1; then
	dryrun "echo ".so man1/gcc.1" > ${destdir}/gcc/doc/g++.1"
    fi

    # Copy all the info files and man pages into the release directory
    local docs="$(find ${builddir}/ -name \*.info -o -name \*.1 -o -name \*.7 | sed -e "s:${builddir}/::")"
    for i in ${docs}; do
	if test $(echo $i | grep -c "\.so\.1") -eq 0; then
      	    dryrun "cp -fv ${builddir}/$i ${destdir}/gcc/doc"
	fi
    done

#    dryrun "rm -fr ${destdir}/${target}"

    return 0
}

# Edit the ChangeLog.linaro file for this release
# $1 - the destination directory for the release files
# $2 - the tag or release string
edit_changelogs()
{
#    trace "$*"

    local destdir="$1"
    local basedir="$(dirname $1)"

    # Update the GCC version, which should look like "4.8-${release}/"
    local tool="$(basename $1)"
#    local version="$(echo $1 | grep -o "[0-9]\.[0-9]-[0-9\.]*")"
    local version="$(echo $1 | grep -o "[0-9]\.[0-9].*/" | tr -d '/')"
    if test -d ${destdir}; then
	rm -f ${destdir}/LINARO-VERSION
	echo "${version}" > ${destdir}/LINARO-VERSION
    else
	warning "${destdir} doesn't exist!"
    fi

    # Jenkins sets these to the name of the requestor. If not set, then we
    # use git, otherwise we wind up with buildslave@locahost.
    if test x"${BUILD_USER_FIRST_NAME}" = x -a x"${BUILD_USER_LAST_NAME}" = x -a x"${BUILD_USER_ID}" = x; then
	local fullname="$(git config user.name)"
	local email="$(git config user.email)"
    else
	local fullname="${BUILD_USER_FIRST_NAME}.${BUILD_USER_LAST_NAME}"
	local email="${BUILD_USER_ID}"
    fi

    local date="$(date +%Y-%m-%d)"

    # Get all the ChangeLog files.
    local clogs="$(find ${basedir}/ -name ChangeLog)"

    # For a dryrun, don't actually edit any ChangeLog files.
    if test x"${dryrun}" = x"no"; then
	local verstr="$(echo "${tool}" | tr "[:lower:]" "[:upper:]") Linaro ${version}"
	for i in ${clogs}; do
	    # Don't do anything if the entry has already been updated.
	    if test -e $i.linaro; then
		if test "$(grep -c "${version}" $i.linaro)" -eq 1; then
		    continue
		fi
     		mv $i.linaro /tmp/
	    else
		touch /tmp/ChangeLog.linaro
	    fi
     	    echo "${date}  ${fullname}  <${email}>" >> $i.linaro
     	    echo "" >> $i.linaro 
	    echo "	${verstr} released." >> $i.linaro
     	    echo "" >> $i.linaro
     	    cat /tmp/ChangeLog.linaro >> $i.linaro
     	    rm -f /tmp/ChangeLog.linaro
	done
    fi
}

# From: https://wiki.linaro.org/WorkingGroups/ToolChain/GDB/ReleaseProcess
# $1 - file name-version to grab from source code control.
release_gdb_src()
{
#    trace "$*"

    # See if specific component versions were specified at runtime
    if test x"${gdb_version}" = x; then
	local gdb_version="$(grep ^latest= ${topdir}/config/gdb.conf | cut -d '\"' -f 2) | tr -d '\"'"
    fi
    local srcdir="$(get_component_srcdir ${gdb_version})"
    # The new combined repository for GDB has Binutils too, so we strip that off.
    local tag="$(create_release_tag ${gdb_version} | sed -e 's:binutils-::')"
    local destdir="/tmp/linaro.$$/${tag}"

    # make a link with the correct name for the tarball's source directory
    dryrun "mkdir -p /tmp/linaro.$$"
    dryrun "ln -sfnT ${srcdir} ${destdir}"
    
    # Update the GDB version
    if test x"${release}" = x;then
	edit_changelogs ${destdir}/gdb ${tag}
    else
	edit_changelogs ${destdir}/gdb ${release}
    fi    
    
#    dryrun "regenerate_checksums ${destdir}"

    # Remove extra files left over from any development hacking
    sanitize ${destdir}

    local exclude="--exclude-vcs --exclude .gitignore --exclude .cvsignore --exclude .libs"
    dryrun "tar Jcfh ${local_snapshots}/${tag}.tar.xz ${exclude} --directory=/tmp/linaro.$$ ${tag}/"

    # Make the md5sum file for this tarball
    rm -f ${local_snapshots}/${tag}.tar.xz.asc
    dryrun "md5sum ${local_snapshots}/${tag}.tar.xz > ${local_snapshots}/${tag}.tar.xz.asc"

    return 0
}

release_newlib()
{
    # First, checkout all the sources, or grab a snapshot
    error "unimplemented"
}

release_eglibc()
{
    # First, checkout all the sources, or grab a snapshot
    error "unimplemented"
}

release_glibc()
{
    # First, checkout all the sources, or grab a snapshot
    error "unimplemented"
}

release_qemu()
{
    # First, checkout all the sources, or grab a snapshot
    error "unimplemented"
}

tag_release()
{
    if test x"$1" = x; then
	local dccs=git
    else
	local dccs = $1
    fi
    error "release TAGging unimplemented"
}

# $1 - The release ttee directory to put the script in for packaging.
sysroot_install_script()
{
#    trace "$*"

    local script=$1/INSTALL-SYSROOT.sh
    local tag="$(basename $1)"

    local sysroot="$(${target}-gcc -print-sysroot)"
    if test ! -e ${script}; then
	cat <<EOF > ${script}
#!/bin/sh

# make the top level directory
if test ! -d /opt/linaro/; then
  echo "This script will install this sysroot in /opt/linaro. Write permission"
  echo "to /opt is required. The files will stay where they are, only a symbolic"
  echo "is created, which can be changed to swap sysroots at compile time."
  echo ""
-  echo "Continue ? Hit any key..."
  read answer

  mkdir -p /opt/linaro
fi

# If it doesn't already exist, link to the sysroot path GCC will be using
ln -sf  \${PWD} ${sysroot}
EOF
    fi

    return 0
}