build/release/docs: New script

This new script:

  * Uses git-describe to generate a version string instead of getting
    the HEAD commit ID from the master branch (which assumed the release
    was being made from master).
  * Optionally includes a version string in the archive file name.
  * Puts documentation files in the release archive under
    libreboot(_$version)_docs/ instead of libreboot_docs/docs/.

2 files changed, 53 insertions, 27 deletions

diff --git a/resources/scripts/helpers/build/release/archives b/resources/scripts/helpers/build/release/archives
index fa8c9a2..aa607af 100755
--- a/resources/scripts/helpers/build/release/archives
+++ b/resources/scripts/helpers/build/release/archives
@@ -59,7 +59,6 @@ rm -rf release/
 rm -rf tobuild/
 rm -rf libreboot_bin
 rm -rf libreboot_src
-rm -rf libreboot_doc
 rm -rf libreboot_crossgcc
 
 # Get manifest which will be used to copy everything
@@ -97,32 +96,6 @@ printf "\n\n"
 mkdir release/
 mkdir release/rom/
 
-# ### Prepare libreboot_docs archive ready for release
-# ----------------------------------------------------------------------------------------------------------------------------
-
-printf "Creating libreboot_docs.tar.xz\n"
-
-cd release/
-
-mkdir libreboot_docs/
-
-cp -r ../docs/ libreboot_docs/
-
-# This file is only for the git repository
-rm -f libreboot_docs/docs/tasks.html
-
-cat ../commitid > libreboot_docs/commitid
-
-# create lzma compressed docs archive
-tar -c libreboot_docs | xz -9e >libreboot_docs.tar.xz
-
-# the directory is no longer needed
-rm -rf libreboot_docs/
-
-cd ../
-
-printf "\n\n"
-
 # ### Further work in libreboot_src: delete *.git and *.svn
 # ### To save space since they are not useful in the release archives
 # ### Changes to these projects should be submitted upstream
diff --git a/resources/scripts/helpers/build/release/docs b/resources/scripts/helpers/build/release/docs
new file mode 100755
index 0000000..a57f8aa
--- /dev/null
+++ b/resources/scripts/helpers/build/release/docs
@@ -0,0 +1,53 @@
+#!/bin/sh
+
+#
+#  helper script: generate the documentation release archive
+#
+#	Copyright (C) 2015 Patrick "P. J." McDermott <pj@pehjota.net>
+#
+#    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, see <http://www.gnu.org/licenses/>.
+#
+
+[ "x${DEBUG+set}" = 'xset' ] && set -v
+set -u -e
+
+printf 'Building the documentation release archive\n'
+
+version="$(git describe --tags HEAD)"
+if [ "x${VERSION_IN_FILENAMES+set}" = 'xset' ]; then
+	distdir="libreboot_${version}_docs"
+else
+	distdir='libreboot_docs'
+fi
+
+printf 'Deleting old documentation release archives\n'
+rm -f "${distdir}.tar.xz"
+rm -f "release/${distdir}.tar.xz"
+rm -Rf "${distdir}/"
+
+printf 'Copying documentation to %s/\n' "${distdir}"
+cp -R docs/ "${distdir}/"
+
+printf '%s\n' "${version}" >"${distdir}/version"
+
+printf 'Creating %s.tar.xz\n' "${distdir}"
+tar -c "${distdir}/" | xz -9e >"${distdir}.tar.xz"
+
+# Move the archives to the release/ directory.
+[ -d release/ ] || mkdir release/
+mv "${distdir}.tar.xz" release/
+
+rm -Rf "${distdir}/"
+
+printf 'Documentation release archives are stored in release/\n'