Commit | Line | Data |
---|---|---|
78b2179a | 1 | README for MAKING BINUTILS RELEASES |
a960d29f | 2 | |
78b2179a NC |
3 | This is a collection of notes on how to perform a binutils release. A |
4 | lot of this information can also be found in the maintain.texi file in | |
5 | the gnulib project: | |
6 | ||
7 | https://www.gnu.org/software/gnulib/ | |
8 | ||
9 | It is useful to have a cloned copy of the sources of this project as | |
10 | it also contains an upload script used to install tarballs on the GNU | |
11 | FTP server. | |
12 | ||
13 | Make sure that you have upload authority on sourceware and fencepost. | |
14 | Beware - this is an involved process and can take weeks to complete. | |
15 | See the maintain.texi file for details on how to obtain these | |
16 | permissions. | |
17 | ||
18 | ------------------------------------------------- | |
19 | How to perform a release. | |
20 | ------------------------------------------------- | |
21 | ||
98ab9e96 NC |
22 | 1. Send an email out warning contributors about the forthcoming |
23 | branch. Set a date for the branch (weekends are better because | |
24 | they are less busy). | |
a960d29f | 25 | |
7ab82037 NC |
26 | 2. When the branch date is near: Update the libiberty and config |
27 | directories and the top level configure files. | |
98ab9e96 NC |
28 | |
29 | 3. When branch day arrives add markers for the upcoming release to | |
f974f26c NC |
30 | the NEWS files in gas, ld, gold and binutils. |
31 | ||
32 | Likewise for the ChangeLog files in: bfd, binutils, config, cpu, | |
33 | elfcpp, gas, gold, gprof, include, ld, opcodes and toplevel. | |
34 | ||
9176ac5b | 35 | Add a note of the name of the new branch to binutils/BRANCHES. |
f974f26c | 36 | |
9176ac5b | 37 | Commit these changes. |
a960d29f | 38 | |
98ab9e96 NC |
39 | 4. Create the release branch using: |
40 | ||
f48dfe41 NC |
41 | git branch binutils-2_33-branch |
42 | git push origin binutils-2_33-branch | |
43 | ||
44 | If you get a message like: | |
45 | ||
46 | remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b | |
47 | ||
48 | It appears that this can be ignored... | |
98ab9e96 | 49 | |
79d89b55 NC |
50 | 5. Make sure that the branch is there. IE check out the branch sources: |
51 | ||
f48dfe41 | 52 | git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_33-branch 2.33 |
79d89b55 NC |
53 | |
54 | If you get a message about being in a "detached head" state, something | |
55 | has gone wrong... | |
56 | ||
f48dfe41 NC |
57 | Keep the checked out sources - they are going to be needed in future steps. |
58 | ||
79d89b55 | 59 | 6. Update "BINUTILS_BRANCH" in gdbadmin's crontab: |
0dd86f32 JB |
60 | |
61 | Log in as gdbadmin on sourceware.org, and then: | |
62 | ||
63 | $ cd crontab | |
64 | $ vi crontab | |
65 | [change BINUTILS_BRANCH] | |
66 | $ cvs ci crontab | |
67 | $ crontab crontab | |
68 | ||
69 | If you do not have access to this account, please feel free to | |
70 | ask Joel Brobecker <brobecker AT adacore DOT com>. | |
71 | ||
79d89b55 | 72 | 7. Rename the current HEAD version entry in Bugzilla, and create a |
f48dfe41 | 73 | new one. E.g. rename "2.33 (HEAD)" to 2.33, and create "2.34 |
7ab82037 NC |
74 | (HEAD)": |
75 | ||
76 | https://sourceware.org/bugzilla/editversions.cgi?product=binutils | |
98ab9e96 | 77 | |
71300e2c NC |
78 | 8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot |
79 | of the next release: | |
80 | ||
f48dfe41 | 81 | m4_define([BFD_VERSION], [2.33.51]) |
71300e2c | 82 | |
eca4b721 | 83 | Update the release number in bfd/version.m4 for the branch. |
71300e2c NC |
84 | The branch only needs the point value set to 90 as the release |
85 | has not actually happened yet. | |
86 | ||
f48dfe41 | 87 | m4_define([BFD_VERSION], [2.32.90]) |
94c2436b NC |
88 | |
89 | Regenerate various files on both branch and HEAD by configuring | |
f48dfe41 NC |
90 | with "--enable-maintainer-mode --enable-gold" and then building |
91 | with "make all-binutils all-gas all-gold all-gprof all-ld" | |
92 | ||
93 | Add ChangeLog entries for the updated files. Commit the changes. | |
94 | Make sure that this includes the .pot files as well as the | |
95 | configure and makefiles. | |
98ab9e96 | 96 | |
71300e2c | 97 | 8. Create an initial prerelease: |
98ab9e96 | 98 | |
79d89b55 | 99 | a. Create a source tarball of the BRANCH sources: |
a960d29f | 100 | |
19e2900b | 101 | ./src-release -x binutils |
a960d29f | 102 | |
71300e2c | 103 | b. Build a test target using this tarball. |
98ab9e96 | 104 | |
71300e2c | 105 | c. Upload the prerelease snapshot to the FTP: |
98ab9e96 | 106 | |
19e2900b NC |
107 | scp ../binutils-$version.tar.xz sourceware.org:~ftp/pub/binutils/snapshots |
108 | ssh sourceware.org md5sum ~ftp/pub/binutils/snapshots/binutils-$version.tar.xz | |
98ab9e96 | 109 | |
79d89b55 NC |
110 | d. Clean up the source directory. |
111 | ||
112 | 9. Tell the Translation Project where to find the new tarball. <coordinator@translationproject.org> | |
113 | qv: http://translationproject.org/html/maintainers.html | |
114 | ||
115 | ------------------------------------------------------------------------ | |
116 | Dear Translation Project | |
117 | ||
118 | The 2.31 release branch has been created for the FSF binutils. | |
119 | ||
120 | A snapshot of the branch sources can be found here: | |
a960d29f | 121 | |
79d89b55 | 122 | https://sourceware.org/pub/binutils/snapshots/binutils-2.30.90.tar.xz |
a960d29f | 123 | |
79d89b55 NC |
124 | We hope to make the official release of the sources on the 8th July |
125 | although that could change if there are important bugs that need to | |
126 | be fixed before the release. | |
127 | ------------------------------------------------------------------------ | |
98ab9e96 | 128 | |
71300e2c | 129 | 10. Announce the availability of the snapshot and the branch on the |
98ab9e96 | 130 | binutils mailing list. Set a date for when the release will |
7ab82037 | 131 | actually happen. Something like: |
79d89b55 NC |
132 | |
133 | ------------------------------------------------------------------------ | |
134 | Hi Everyone, | |
135 | ||
136 | The 2.XX branch has now been created: | |
137 | ||
138 | git clone git://sourceware.org/git/binutils-gdb.git -b binutils-2_XX-branch 2.XX | |
139 | ||
140 | A snapshot of the sources is also available here: | |
141 | ||
142 | https://sourceware.org/pub/binutils/snapshots/binutils-2.XX.90.tar.xz | |
143 | ||
144 | Please could all patches for the branch be run by me. | |
145 | The rules for the branch are: | |
146 | ||
147 | * No new features. | |
148 | * Target specific bug fixes are OK. | |
149 | * Generic bug fixes are OK if they are important and widely tested. | |
150 | * Documentation updates/fixes are OK. | |
151 | * Translation updates are OK. | |
152 | * Fixes for testsuite failures are OK. | |
153 | ||
154 | Ideally I would like to make the release happen in two weeks time, | |
155 | i.e. Saturday 27th Jan. Which I hope will be enough time for everyone | |
156 | to get their final fixes in. | |
157 | ------------------------------------------------------------------------ | |
158 | ||
159 | 11. Build various different toolchains, test them and nag | |
7ab82037 NC |
160 | maintainers to fix any testsuite failures for their |
161 | architectures... | |
162 | ||
98ab9e96 | 163 | |
94c2436b NC |
164 | When the time comes to actually make the release.... |
165 | ||
166 | ||
9a5db26e | 167 | 20. Make sure that the branch sources still build, test and install |
6cb624f8 NC |
168 | correctly. Make sure that the sources are clean, without any |
169 | patch files (.reg .orig *~) left over. | |
170 | ||
171 | cd <branch> | |
172 | cvsclean | xargs rm | |
9a5db26e NC |
173 | |
174 | 21. Update the release number in bfd/version.m4 on the release | |
94c2436b NC |
175 | branch to a whole new minor version number, without a point |
176 | value. Eg "2.29.90" becomes "2.30". Change bfd/development.sh | |
44c2eb66 | 177 | to set all values to "false". Regenerate the configure and |
e2561448 NC |
178 | makefiles. And *info* files. Add ChangeLog entries for the |
179 | updates and add a "this-is-the-2.XX-release" comment and | |
180 | commit. Make sure to include the .gmo files. | |
9a5db26e NC |
181 | |
182 | 22. Check that your file creation mask will create the | |
183 | correct file permissions. Eg: | |
184 | ||
6cb624f8 NC |
185 | % umask |
186 | 22 | |
187 | ||
188 | Remove any spurious autom4te.cache files left over from the | |
189 | reconfiguring: | |
190 | ||
191 | % find . -depth -name autom4te.cache -exec rm -r {} \; | |
9a5db26e | 192 | |
ad96220c NC |
193 | 23. Note - check to see if any new files have been added to the top |
194 | level of the source directory, but which are not in the | |
195 | DEVO_SUPPORT variable in the src-release.sh script. If they are | |
196 | needed then add them. | |
197 | ||
198 | Create the release tarballs: | |
9a5db26e | 199 | |
6cb624f8 | 200 | ./src-release.sh -b -g -l -x binutils |
9a5db26e NC |
201 | |
202 | 24. Check that the files in the tarballs have the correct | |
6cb624f8 | 203 | permissions. |
9a5db26e NC |
204 | |
205 | 25. Sanity check the release on x86_64-pc-linux-gnu by building and | |
206 | running the testsuite. Make the source directory read-only | |
207 | before building. Also test "make install". If necessary fix | |
208 | any problems. | |
209 | ||
210 | 26. Tag the branch with the new release number: | |
211 | ||
212 | git tag -a binutils-2_XX | |
213 | [optional: add "-u XXXXX" to sign with a gpg key] | |
214 | git push origin binutils-2_XX | |
215 | ||
a8d6d6ac NC |
216 | NB/ If you do sign the binaries make sure to use a key |
217 | that has been published with the FSF. | |
218 | ||
6cb624f8 | 219 | 27. Upload the tarballs to ftp.gnu.org. |
9a5db26e | 220 | |
a8d6d6ac | 221 | gnupload --to ftp.gnu.org:binutils binutils-X.XX.tar.* |
9a5db26e NC |
222 | |
223 | The gnupload script is in the gnulib/build-aux directory. | |
224 | ||
a8d6d6ac NC |
225 | Check for an email response from the upload. If necessary |
226 | fix any problems. | |
227 | ||
6cb624f8 | 228 | 28. Upload the tarballs (and signatures) to sourceware.org: |
9a5db26e NC |
229 | |
230 | sftp sourceware.org | |
231 | cd /sourceware/ftp/pub/binutils/releases | |
232 | put binutils-X.XX.tar.* | |
233 | chmod 644 binutils-X.XX.tar.* | |
234 | quit | |
235 | ||
236 | FIXME: Should the signatures (created by the gnupload script in | |
237 | step 29) be uploaded as well ? | |
238 | ||
6cb624f8 | 239 | 29. Update web pages. For sourceware.org: |
9a5db26e NC |
240 | |
241 | Create a new documentation folder on the sourceware.org web | |
242 | pages as /sourceware/www/sourceware/htdocs/binutils/docs-X.XX. | |
243 | Make the html documentation locally with the "make html" command | |
ad96220c NC |
244 | and then upload and rename the directories as needed. (sftp |
245 | does not appear to support recursive uploads however, so the | |
246 | directories will have to be made by hand). Create an | |
9a5db26e NC |
247 | index.html file and then edit the docs link to point to the new |
248 | docs-X.XX directory. | |
249 | ||
6cb624f8 NC |
250 | Update the index.html file in the directory containing the |
251 | docs-X.XX entries to point to the new documentation and mention | |
252 | the new version. | |
9a5db26e NC |
253 | |
254 | For the www.gnu.org site you have to email webmasters@gnu.org | |
255 | and ask them to make the change(s). | |
256 | ||
6cb624f8 | 257 | 30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and |
9a5db26e NC |
258 | David Edelsohn <dje.gcc@gmail.com> announcing the new release. |
259 | Sign the email and include the checksum. | |
260 | (The email to Davis is so that he can update the GNU Toolchain | |
261 | social media). Something like this: | |
262 | ------------------------------------------------------------------------ | |
263 | Hi Everyone, | |
264 | ||
ad96220c | 265 | We are pleased to announce that version 2.XX of the GNU Binutils project |
9a5db26e NC |
266 | sources have been released and are now available for download at: |
267 | ||
268 | https://ftp.gnu.org/gnu/binutils | |
269 | https://sourceware.org/pub/binutils/releases/ | |
270 | ||
271 | checksums: xxxx | |
94c2436b | 272 | |
9a5db26e NC |
273 | This release contains numerous bug fixes, and also the |
274 | following new features: | |
78b2179a | 275 | |
9a5db26e | 276 | <extract info from the NEWS files> |
94c2436b | 277 | |
9a5db26e NC |
278 | Our thanks go out to all of the binutils contributors, past and |
279 | present, for helping to make this release possible. | |
94c2436b | 280 | |
9a5db26e | 281 | -------------------------------------------------------------------------- |
94c2436b | 282 | |
6cb624f8 NC |
283 | 31. Clean up the source tree. (Use "git status" to find new |
284 | files, and remove them). | |
285 | ||
286 | 32. Edit bfd/development.sh on the branch and set | |
287 | "development=true". Also bump the version in bfd/version.m4 by | |
288 | adding a trailing .0, so that the date suffix keeps the version | |
289 | lower than the trunk version. Regenerate files. Commit these | |
290 | changes. | |
291 | ||
292 | 33. Email the binutils list telling everyone that the 2.31 branch | |
293 | is now open for business as usual and that patched no longer | |
294 | need special approval. | |
295 | ||
78b2179a NC |
296 | ------------------------------------------------- |
297 | How to perform a point release. | |
298 | ------------------------------------------------- | |
299 | ||
300 | A point release is easier than a normal release since a lot of the | |
301 | work has already been done. The branch has been created, the | |
302 | translations updated and the documentation uploaded. So the procedure | |
303 | looks like this: | |
304 | ||
305 | 0. Decide that a point release is necessary. | |
306 | ||
307 | Usually this only happens when a sufficient number of serious | |
308 | bugs have been found and fixed since the previous release, and a | |
309 | new official release is not imminent. | |
310 | ||
311 | 1. Tell the community that a point release is happening. Ask | |
312 | maintainers to ensure that their ports are up to date on the | |
313 | release branch. Ask the community if there are any bug fixes | |
314 | which are missing from the branch. Allow some time for the | |
315 | responses to this step. | |
316 | ||
317 | 2. Make sure that the branch sources build, test and install | |
318 | correctly. | |
319 | ||
98ab9e96 NC |
320 | 2.5 Prepare a list of the bugs which have been fixed. This |
321 | will be needed for step 8. | |
a960d29f | 322 | |
ef336cb0 | 323 | 3. In the branch sources: |
a960d29f | 324 | |
ef336cb0 | 325 | a. Update the minor release number in bfd/version.m4. |
44c2eb66 L |
326 | b. Edit bfd/development.sh, set "development=false" and |
327 | "experimental=false". | |
ef336cb0 | 328 | c. Regenerate the configure files. |
442a6ce8 NC |
329 | c.1. Remove spurious autom4te.cache files: |
330 | ||
331 | find . -depth -name autom4te.cache -exec rm -r {} \; | |
332 | ||
ef336cb0 NC |
333 | d. Commit the updates along with a "this-is-the-2.XX.X-release" |
334 | note in all of the changelogs. | |
335 | e. Tag the branch with the new release number: | |
336 | ||
337 | git tag -a binutils-2_XX_X | |
338 | [optional: add "-u XXXXX" to sign with a gpg key] | |
339 | git push origin binutils-2_XX_X | |
340 | ||
8071ec09 NC |
341 | f. Check that your file creation mask will create the |
342 | correct file permissions. Eg: | |
343 | ||
344 | umask 022 | |
a960d29f | 345 | |
8071ec09 | 346 | g. Create the release tarballs: |
ef336cb0 | 347 | ./src-release -b -g -l -x binutils |
8071ec09 NC |
348 | |
349 | h. Check that the files in the tarballs have the correct | |
350 | permissions. | |
a960d29f | 351 | |
8071ec09 NC |
352 | i. Edit bfd/development.sh and set "development=true". |
353 | j. Commit this change into the git repository. | |
354 | k. Clean up the source tree. (Use "git status" to find new | |
ef336cb0 | 355 | files, and remove them). |
78b2179a | 356 | |
ef336cb0 NC |
357 | 4. [If paranoid - upload the tarballs to one of the FTP servers and |
358 | ask people to test it before going on to step 5]. | |
a960d29f | 359 | |
ef336cb0 | 360 | 5. Upload the tarballs to ftp.gnu.org. |
78b2179a NC |
361 | |
362 | gnupload --to ftp.gnu.org:binutils binutils-X.XX.X.tar.* | |
363 | ||
ef336cb0 | 364 | The gnupload script is in the gnulib/build-aux directory. |
78b2179a | 365 | |
ef336cb0 | 366 | 6. Upload the tarballs to sourceware.org: |
78b2179a NC |
367 | |
368 | sftp sourceware.org | |
442a6ce8 | 369 | cd /sourceware/ftp/pub/binutils/releases |
78b2179a NC |
370 | put binutils-X.XX.X.tar.* |
371 | chmod 644 binutils-X.XX.X.tar.* | |
372 | quit | |
373 | ||
442a6ce8 | 374 | It is OK to upload the signatures as well. |
78b2179a | 375 | |
ef336cb0 | 376 | 7. Update web pages. For sourceware.org: |
78b2179a NC |
377 | |
378 | * Log on to sourceware.org | |
442a6ce8 | 379 | * Go to /sourceware/www/sourceware/htdocs/binutils |
78b2179a NC |
380 | * Edit index.html |
381 | ||
382 | For the www.gnu.org site you have to email webmasters@gnu.org | |
383 | and ask them to make the change(s). | |
384 | ||
ef336cb0 NC |
385 | 8. Send an emails to the binutils list, info-gnu@gnu.org and |
386 | David Edelsohn <dje.gcc@gmail.com> announcing the new release. | |
387 | (The email to Davis is so that he can update the GNU Toolchain | |
388 | social media). Something like this: | |
78b2179a NC |
389 | ------------------------------------------------------------------------ |
390 | Hi Everyone, | |
391 | ||
442a6ce8 NC |
392 | We are pleased to announce that version 2.XX.X of the GNU Binutils |
393 | project sources have been released and are now available for download at: | |
a960d29f | 394 | |
78b2179a NC |
395 | https://ftp.gnu.org/gnu/binutils |
396 | https://sourceware.org/pub/binutils/releases/ | |
397 | ||
398 | This is a point release over the previous 2.XX version, containing bug | |
399 | fixes but no new features. | |
400 | ||
401 | Our thanks go out to all of the binutils contributors, past and | |
402 | present, for helping to make this release possible. | |
98ab9e96 NC |
403 | |
404 | Here is a list of the bugs that have been fixed: | |
405 | xx | |
406 | xx | |
407 | xx | |
408 | xx | |
78b2179a NC |
409 | -------------------------------------------------------------------------- |
410 | ||
411 | \f | |
82704155 | 412 | Copyright (C) 2017-2019 Free Software Foundation, Inc. |
78b2179a NC |
413 | |
414 | Copying and distribution of this file, with or without modification, | |
415 | are permitted in any medium without royalty provided the copyright | |
416 | notice and this notice are preserved. |