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