gnulib: import gendocs
[binutils-gdb.git] / gnulib / update-gnulib.sh
1 #! /bin/sh
2
3 # Copyright (C) 2011-2021 Free Software Foundation, Inc.
4 #
5 # This file is part of GDB.
6 #
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20 # Usage: update-gnulib.sh <path-to-gnulib-repository>
21 # Update our import of gnulib in the GDB source tree.
22 #
23 # This script assumes that it is being called from the gdb/gnulib
24 # subdirectory, and will verify this before proceeding.
25 #
26 # This script will also make a number of other verifications:
27 # . The gnulib version (it should match $GNULIB_COMMIT_SHA1).
28 # . The correct versions of the auto-tools that are used to
29 # regenerate the various scripts and Makefiles are on the PATH.
30
31 # The list of gnulib modules we are importing in GDB.
32 IMPORTED_GNULIB_MODULES="\
33 alloca \
34 canonicalize-lgpl \
35 count-one-bits \
36 dirent \
37 dirfd \
38 errno \
39 fnmatch-gnu \
40 frexpl \
41 gendocs \
42 getcwd \
43 getline \
44 gettimeofday \
45 gitlog-to-changelog \
46 glob \
47 inet_ntop
48 inttypes \
49 lstat \
50 limits-h \
51 memchr \
52 memmem \
53 mkdir \
54 mkdtemp \
55 mkostemp \
56 pathmax \
57 rawmemchr \
58 readlink \
59 rename \
60 setenv \
61 signal-h \
62 strchrnul \
63 strerror_r-posix \
64 strstr \
65 strtok_r \
66 sys_stat \
67 time_r \
68 unistd \
69 unsetenv \
70 update-copyright \
71 wchar \
72 wctype-h \
73 "
74
75 # The gnulib commit ID to use for the update.
76 GNULIB_COMMIT_SHA1="776af40e09b476a41073131a90022572f448c189"
77
78 # The expected version number for the various auto tools we will
79 # use after the import.
80 AUTOCONF_VERSION="2.69"
81 AUTOMAKE_VERSION="1.15.1"
82 ACLOCAL_VERSION="$AUTOMAKE_VERSION"
83
84 if [ $# -ne 1 ]; then
85 echo "Error: Path to gnulib repository missing. Aborting."
86 echo "Usage: update-gnulib.sh <path-to-gnulib-repository>"
87 exit 1
88 fi
89 gnulib_prefix=$1
90
91 gnulib_tool="$gnulib_prefix/gnulib-tool"
92
93 # Verify that the gnulib directory does exist...
94 if [ ! -f "$gnulib_tool" ]; then
95 echo "Error: Invalid gnulib directory. Cannot find gnulib tool"
96 echo " ($gnulib_tool)."
97 echo "Aborting."
98 exit 1
99 fi
100
101 # Verify that we have the right version of gnulib...
102 gnulib_head_sha1=`cd $gnulib_prefix && git rev-parse HEAD`
103 if [ "$gnulib_head_sha1" != "$GNULIB_COMMIT_SHA1" ]; then
104 echo "Error: Wrong version of gnulib: $gnulib_head_sha1"
105 echo " (we expected it to be $GNULIB_COMMIT_SHA1)"
106 echo "Aborting."
107 exit 1
108 fi
109
110 # Verify that we are in the correct directory.
111 if [ ! -f ../gdb/main.c -o ! -d import ]; then
112 echo "Error: This script should be called from the gnulib subdirectory."
113 echo "Aborting."
114 exit 1
115 fi
116
117 # Verify that we have the correct version of autoconf.
118 ver=`autoconf --version 2>&1 | head -1 | sed 's/.*) //'`
119 if [ "$ver" != "$AUTOCONF_VERSION" ]; then
120 echo "Error: Wrong autoconf version ($ver), we need $AUTOCONF_VERSION."
121 echo "Aborting."
122 exit 1
123 fi
124
125 # Verify that we have the correct version of automake.
126 ver=`automake --version 2>&1 | head -1 | sed 's/.*) //'`
127 if [ "$ver" != "$AUTOMAKE_VERSION" ]; then
128 echo "Error: Wrong automake version ($ver), we need $AUTOMAKE_VERSION."
129 echo "Aborting."
130 exit 1
131 fi
132
133 # Verify that we have the correct version of aclocal.
134 #
135 # The grep below is needed because Perl >= 5.16 dumps a "called too
136 # early to check prototype" warning when running aclocal 1.11.1. This
137 # causes trouble below, because the warning is the first line output
138 # by aclocal, resulting in:
139 #
140 # $ sh ./update-gnulib.sh ~/src/gnulib/src/
141 # Error: Wrong aclocal version: called too early to check prototype at /opt/automake-1.11.1/bin/aclocal line 617.. Aborting.
142 #
143 # Some distros carry an automake patch for that:
144 # https://bugs.debian.org/cgi-bin/bugreport.cgi?msg=5;filename=aclocal-function-prototypes.debdiff;att=1;bug=752784
145 #
146 # But since we prefer pristine FSF versions of autotools, work around
147 # the issue here. This can be removed later when we bump the required
148 # automake version.
149 #
150 ver=`aclocal --version 2>&1 | grep -v "called too early to check prototype" | head -1 | sed 's/.*) //'`
151 if [ "$ver" != "$ACLOCAL_VERSION" ]; then
152 echo "Error: Wrong aclocal version ($ver), we need $ACLOCAL_VERSION."
153 echo "Aborting."
154 exit 1
155 fi
156
157 # Update our gnulib import.
158 $gnulib_prefix/gnulib-tool --import --dir=. --lib=libgnu \
159 --source-base=import --m4-base=import/m4 --doc-base=doc \
160 --tests-base=tests --aux-dir=import/extra \
161 --no-conditional-dependencies --no-libtool --macro-prefix=gl \
162 --no-vc-files \
163 $IMPORTED_GNULIB_MODULES
164 if [ $? -ne 0 ]; then
165 echo "Error: gnulib import failed. Aborting."
166 exit 1
167 fi
168
169 # Apply our local patches.
170 apply_patches ()
171 {
172 patch -p2 -f -i "$1"
173 if [ $? -ne 0 ]; then
174 echo "Failed to apply some patches. Aborting."
175 exit 1
176 fi
177 }
178
179 apply_patches "patches/0001-use-windows-stat"
180
181 # Regenerate all necessary files...
182 aclocal &&
183 autoconf &&
184 autoheader &&
185 automake
186 if [ $? -ne 0 ]; then
187 echo "Error: Failed to regenerate Makefiles and configure scripts."
188 exit 1
189 fi