2 # Run this after each non-alpha release, to update the web documentation at
3 # http://www.gnu.org/software/$pkg/manual/
5 VERSION=2016-01-12.23; # UTC
7 # Copyright (C) 2009-2016 Free Software Foundation, Inc.
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 warn() { printf '%s: %s\n' "$ME" "$*" >&2; }
24 die() { warn "$*"; exit 1; }
31 Run this script from top_srcdir (no arguments) after each non-alpha
32 release, to update the web documentation at
33 http://www.gnu.org/software/\$pkg/manual/
35 This script assumes you're using git for revision control, and
36 requires a .prev-version file as well as a Makefile, from which it
37 extracts the version number and package name, respectively. Also, it
38 assumes all documentation is in the doc/ sub-directory.
41 -C, --builddir=DIR location of (configured) Makefile (default: .)
42 -n, --dry-run don't actually commit anything
43 -m, --mirror remove out of date files from document server
44 --help print this help, then exit
45 --version print version number, then exit
47 Report bugs and patches to <bug-gnulib@gnu.org>.
54 year=$(echo "$VERSION" | sed 's/[^0-9].*//')
57 Copyright (C) $year Free Software Foundation, Inc,
58 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
59 This is free software: you are free to change and redistribute it.
60 There is NO WARRANTY, to the extent permitted by law.
65 # find_tool ENVVAR NAMES...
66 # -------------------------
67 # Search for a required program. Use the value of ENVVAR, if set,
68 # otherwise find the first of the NAMES that can be run (i.e.,
69 # supports --version). If found, set ENVVAR to the program name,
72 # FIXME: code duplication, see also bootstrap.
78 eval "find_tool_res=\$$find_tool_envvar"
79 if test x"$find_tool_res" = x; then
82 if ($i --version </dev/null) >/dev/null 2>&1; then
88 find_tool_error_prefix="\$$find_tool_envvar: "
90 test x"$find_tool_res" != x \
91 || die "one of these is required: $find_tool_names"
92 ($find_tool_res --version </dev/null) >/dev/null 2>&1 \
93 || die "${find_tool_error_prefix}cannot run $find_tool_res --version"
94 eval "$find_tool_envvar=\$find_tool_res"
95 eval "export $find_tool_envvar"
102 # Requirements: everything required to bootstrap your package, plus
106 find_tool RSYNC rsync
107 find_tool XARGS gxargs xargs
114 # Handle --option=value by splitting apart and putting back on argv.
117 opt=$(echo "$1" | sed -e 's/=.*//')
118 val=$(echo "$1" | sed -e 's/[^=]*=//')
120 set dummy "$opt" "$val" "$@"; shift
125 --help|--version) ${1#--};;
126 -C|--builddir) shift; builddir=$1; shift ;;
127 -n|--dry-run) dryrun=echo; shift;;
128 -m|--mirror) rm_stale=''; shift;;
129 --*) die "unrecognized option: $1";;
135 || die "too many arguments"
138 version=$(cat $prev) || die "no $prev file?"
139 pkg=$(sed -n 's/^PACKAGE = \(.*\)/\1/p' $builddir/Makefile) \
140 || die "no Makefile?"
141 tmp_branch=web-doc-$version-$$
142 current_branch=$($GIT branch | sed -ne '/^\* /{s///;p;q;}')
147 $dryrun rm -rf "$tmp"
148 $GIT checkout "$current_branch"
149 $GIT submodule update --recursive
150 $GIT branch -d $tmp_branch
154 trap 'exit $?' 1 2 13 15
156 # We must build using sources for which --version reports the
157 # just-released version number, not some string like 7.6.18-20761.
158 # That version string propagates into all documentation.
160 $GIT checkout -b $tmp_branch v$version
161 $GIT submodule update --recursive
166 ./config.status --recheck
173 tmp=$(mktemp -d web-doc-update.XXXXXX) || exit 1
175 && $CVS -d $USER@cvs.sv.gnu.org:/webcvs/$pkg co $pkg )
176 $RSYNC -avP "$builddir"/doc/manual/ $tmp/$pkg/manual
181 # Add all the files. This is simpler than trying to add only the
182 # new ones because of new directories
183 # First add non empty dirs individually
184 find . -name CVS -prune -o -type d \! -empty -print \
185 | $XARGS -n1 --no-run-if-empty -- $dryrun $CVS add -ko
187 find . -name CVS -prune -o -type f -print \
188 | $XARGS --no-run-if-empty -- $dryrun $CVS add -ko
190 # Report/Remove stale files
191 # excluding doc server specific files like CVS/* and .symlinks
192 if test -n "$rm_stale"; then
193 echo 'Consider the --mirror option if all of the manual is generated,' >&2
194 echo 'which will run `cvs remove` to remove stale files.' >&2
196 { find . \( -name CVS -o -type f -name '.*' \) -prune -o -type f -print
197 (cd "$builddir"/doc/manual/ && find . -type f -print | sed p)
199 | $XARGS --no-run-if-empty -- ${rm_stale:-$dryrun} $CVS remove -f
201 $dryrun $CVS ci -m $version
205 # eval: (add-hook 'write-file-hooks 'time-stamp)
206 # time-stamp-start: "VERSION="
207 # time-stamp-format: "%:y-%02m-%02d.%02H"
208 # time-stamp-time-zone: "UTC0"
209 # time-stamp-end: "; # UTC"