source: rtems-release/rtems-release-docs @ ead5f49

#! /bin/sh
#
# RTEMS Tools Project (http://www.rtems.org/)
# Copyright 2015-2016 Chris Johns (chrisj@rtems.org)
# All rights reserved.
#
# This file is part of the RTEMS Tools package in 'rtems-tools'.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

#
# This worker script to build the doco.
#
echo "RTEMS Documentation Release builder, v0.1"

#
# Defaults.
#
. ${release_top}/rtems-release-defaults

#
# Only build if sphinx-build is present on the system.
#
if [ "`command -v sphinx-build`"no = no ]; then
 echo "warning: documentation not built"
 exit 0
fi

#
# Common package start.
#
. ./rtems-release-package-start

#
# The workspace pwd
#
ws_pwd=${PWD}

#
# Get the documentation, create the tarball and stamp.
#
echo "git clone ${git_remote} ${git_local}"
git clone ${git_remote} ${git_local}

cd ${git_local}
 echo "git fetch origin"
 git fetch origin
 echo "git archive --format=tar --prefix=${prefix}/ origin/${version}"
 git archive --format=tar --prefix=${prefix}/ origin/${version} | \
     xz > ../${prefix}-unstamped.tar.xz
 cd ..

#
# Stamp the source and package
#
echo "tar Jxf ../${prefix}-unstamped.tar.xz"
tar Jxf ${prefix}-unstamped.tar.xz

cd ${prefix}
 #
 # This is a hack until I add support for the VERSION file created below.
 #
 cat wscript | sed -e "s/^version[[:space:]].*=.*$/version = '${release}'/g" > wscript.tmp
 rm -f wscript
 mv wscript.tmp wscript
 echo "Creating VERSION: ${release}"
 echo "[version]" > VERSION
 echo "release = ${release}" >> VERSION
 cd ..

echo "tar cf - ${prefix}"
tar cf - ${prefix} | xz > ../${prefix}.tar.xz

echo "Created: ${release}/${prefix}.tar.xz"

#
# Build the docs.
#
mkdir install
cd ${prefix}
 ./waf distclean configure --prefix=../install/${prefix} --pdf --singlehtml
 ./waf build install
 cd ..

#
# Package the docs, PDF first.
#
mkdir ${top}/${release}/docs
cd install
 echo "Creating DOC all rtems-${release}-docs-all.tar.xz"
 tar cf - * > ${top}/${release}/docs/rtems-${release}-docs-all.tar.xz
 for p in $(find . -name \*.pdf)
 do
  manual=$(echo $(basename $p) | sed -e "s/\\..*//")
  base=$(dirname $p)
  #
  # Compress the PDF and move it out of the way.
  #
  echo "Creating PDF rtems-${release}-${manual}.pdf.xz"
  xz $p
  mv $p.xz ${top}/${release}/docs/rtems-${release}-${manual}.pdf.xz
  #
  # Create the single html manual
  #
  echo "Creating SingleHTML rtems-${release}-${manual}.html.xz"
  mv ${base}/${manual}.html ${base}/rtems-${release}-${manual}.html
  xz ${base}/rtems-${release}-${manual}.html
  mv ${base}/rtems-${release}-${manual}.html.xz ${top}/${release}/docs/.
  #
  # Tar the multi-page html and install.
  #
  echo "Creating HTML rtems-${release}-${manual}-html.tar.xz"
  tar cf - ${base}/${manual} > ${top}/${release}/docs/rtems-${release}-${manual}-html.tar.xz
 done
 cd ..

#
# Comman package end.
#
. ${top}/rtems-release-package-end

cd ${release}/docs
 rm -f ${checksum}sum.txt
 for f in $(ls -1)
 do
  if [ ! -d ${f} ]; then
   csum=$(${checksum} -q ${f})
   echo "${csum} ${f}" >> ${checksum}sum.txt
  fi
 done
 cd ..

echo "Created: ${release}/docs/${checksum}sum.txt"
echo "Created: ${release}/docs"

exit 0