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