]>
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 | ||
311578da NC |
18 | Note - when performing a release it is helpful to edit this document |
19 | as you go, updating the example commands so that they are ready for | |
20 | the release that follows. | |
21 | ||
78b2179a NC |
22 | ------------------------------------------------- |
23 | How to perform a release. | |
24 | ------------------------------------------------- | |
25 | ||
311578da NC |
26 | 1. Choose dates for the branch and release. Weekends are better |
27 | because they are less busy. It is typical to leave two weeks | |
28 | between creating the branch and creating the release. | |
29 | ||
30 | Send an email out warning contributors about the forthcoming | |
31 | branch and release. | |
a960d29f | 32 | |
7ab82037 | 33 | 2. When the branch date is near: Update the libiberty and config |
055bc77a NC |
34 | directories and the top level Makefile and configure files. Also |
35 | consider updating the toplevel libtool files. | |
98ab9e96 | 36 | |
dd78c0a8 NC |
37 | ------------------------------------------------- |
38 | How to create the release branch. | |
39 | ------------------------------------------------- | |
40 | ||
be2c7885 NC |
41 | Approx time to complete from here: 2 hours .... |
42 | ||
826eed80 NC |
43 | 2.5 If you have not built from the sources recently then now is the |
44 | time to check that they still work... | |
a72b0718 | 45 | |
98ab9e96 | 46 | 3. When branch day arrives add markers for the upcoming release to |
03d0d46a NC |
47 | the NEWS files in gas, ld, and binutils. No need to update NEWS |
48 | in the gold directory - it has its own release numbering. | |
f974f26c NC |
49 | |
50 | Likewise for the ChangeLog files in: bfd, binutils, config, cpu, | |
a72b0718 | 51 | elfcpp, gas, gold, gprof, include, ld, libctf, opcodes and toplevel. |
f974f26c | 52 | |
9176ac5b | 53 | Add a note of the name of the new branch to binutils/BRANCHES. |
f974f26c | 54 | |
9176ac5b | 55 | Commit these changes. |
a960d29f | 56 | |
98ab9e96 NC |
57 | 4. Create the release branch using: |
58 | ||
87485f53 NC |
59 | git branch binutils-2_42-branch |
60 | git push origin binutils-2_42-branch | |
f48dfe41 NC |
61 | |
62 | If you get a message like: | |
63 | ||
64 | remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b | |
65 | ||
66 | It appears that this can be ignored... | |
98ab9e96 | 67 | |
79d89b55 NC |
68 | 5. Make sure that the branch is there. IE check out the branch sources: |
69 | ||
96e786d1 | 70 | git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_41-branch 2.41 |
79d89b55 NC |
71 | |
72 | If you get a message about being in a "detached head" state, something | |
73 | has gone wrong... | |
74 | ||
082cbd3b NC |
75 | Keep the checked out sources - they are going to be needed in future |
76 | steps. | |
f48dfe41 | 77 | |
79d89b55 | 78 | 6. Update "BINUTILS_BRANCH" in gdbadmin's crontab: |
0dd86f32 JB |
79 | |
80 | Log in as gdbadmin on sourceware.org, and then: | |
81 | ||
82 | $ cd crontab | |
83 | $ vi crontab | |
84 | [change BINUTILS_BRANCH] | |
85 | $ cvs ci crontab | |
86 | $ crontab crontab | |
87 | ||
88 | If you do not have access to this account, please feel free to | |
89 | ask Joel Brobecker <brobecker AT adacore DOT com>. | |
90 | ||
79d89b55 | 91 | 7. Rename the current HEAD version entry in Bugzilla, and create a |
87485f53 NC |
92 | new one. E.g. rename "2.42 (HEAD)" to 2.42, and create |
93 | "2.43 (HEAD)": | |
7ab82037 NC |
94 | |
95 | https://sourceware.org/bugzilla/editversions.cgi?product=binutils | |
98ab9e96 | 96 | |
71300e2c | 97 | 8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot |
96e786d1 | 98 | of the next release and the BRANCH to indicate that it is almost |
631ec08c NC |
99 | ready for the release. |
100 | ||
96e786d1 NC |
101 | So if the release is going to be 2.41 then the version number on |
102 | the BRANCH should be set to 2.40.90 - ie almost, but not quite 2.41, | |
103 | and the version number on the MAINLINE should be set to 2.41.50 - | |
104 | ie half way to 2.42 release. | |
5f7a57f1 | 105 | |
87485f53 | 106 | So the BRANCH bfd/version.m4 has: |
71300e2c | 107 | |
87485f53 | 108 | m4_define([BFD_VERSION], [2.41.90]) |
71300e2c | 109 | |
87485f53 | 110 | and the MAINLINE has: |
71300e2c | 111 | |
87485f53 | 112 | m4_define([BFD_VERSION], [2.42.50]) |
94c2436b NC |
113 | |
114 | Regenerate various files on both branch and HEAD by configuring | |
bb368aad VM |
115 | with "--enable-maintainer-mode --enable-gold --enable-shared" and then building |
116 | with "make all-binutils all-gas all-gold all-gprof all-gprofng all-ld" | |
f48dfe41 NC |
117 | |
118 | Add ChangeLog entries for the updated files. Commit the changes. | |
119 | Make sure that this includes the .pot files as well as the | |
120 | configure and makefiles. | |
98ab9e96 | 121 | |
b248e9ce | 122 | 9. Create an initial pre-release: |
98ab9e96 | 123 | |
04d7fa21 NC |
124 | a. Remove any auto-generated files, in order to force the |
125 | src-release script to rebuild them. | |
126 | ||
127 | cd <branch-sources> | |
be2c7885 | 128 | git clean -fdx |
04d7fa21 NC |
129 | |
130 | b. Create a source tarball of the BRANCH sources: | |
a960d29f | 131 | |
bb368aad | 132 | ./src-release.sh -x binutils |
a960d29f | 133 | |
d41af08c NC |
134 | FIXME: Not sure if the following steps are needed... |
135 | ||
136 | Add a .dirstamp file to the gas/doc subdirectory: | |
137 | ||
138 | touch -d <today's date> binutils-2.<release>/gas/doc/.dirstamp | |
139 | tar rvf binutils-<release>.tar binutils-<release>/gas/doc/.ditstamp | |
140 | rm binutils-<release>.tar.xz | |
141 | xz -9 binutils-<release>.tar | |
142 | ||
143 | eg: | |
0d368ae5 NC |
144 | touch -d 2024-01-01 binutils-2.41.90/gas/doc/.dirstamp |
145 | tar rvf binutils-2.41.90.tar binutils-2.41.90/gas/doc/.dirstamp | |
146 | rm binutils-2.41.90.tar.xz | |
147 | xz -9 binutils-2.41.90.tar | |
d41af08c NC |
148 | |
149 | ...END OF FIXME | |
150 | ||
04d7fa21 | 151 | c. Build a test target using this tarball. |
98ab9e96 | 152 | |
0d368ae5 | 153 | cp binutils-2.41.90.tar.xz /dev/shm |
be2c7885 | 154 | pushd /dev/shm |
0d368ae5 | 155 | tar xvf binutils-2.41.90.tar.xz |
375cd423 NC |
156 | mkdir build |
157 | cd build | |
0d368ae5 | 158 | ../binutils-2.41.90/configure --quiet --enable-gold |
375cd423 | 159 | make |
be2c7885 | 160 | popd |
98ab9e96 | 161 | |
375cd423 NC |
162 | If there are problems, fix them. |
163 | ||
04d7fa21 | 164 | d. Upload the pre-release snapshot to the sourceware FTP site: |
375cd423 | 165 | |
d41af08c NC |
166 | scp binutils-2.40.90.tar.xz sourceware.org:/var/ftp/pub/binutils/snapshots |
167 | ssh sourceware.org sha256sum ~ftp/pub/binutils/snapshots/binutils-2.40.90.tar.xz | |
98ab9e96 | 168 | |
04d7fa21 NC |
169 | e. Clean up the source directory again. |
170 | ||
be2c7885 | 171 | git clean -fdx |
375cd423 | 172 | |
b248e9ce | 173 | 10. Tell the Translation Project where to find the new tarball. |
082cbd3b | 174 | <coordinator@translationproject.org> |
be2c7885 | 175 | qv: https://translationproject.org/html/maintainers.html |
79d89b55 NC |
176 | |
177 | ------------------------------------------------------------------------ | |
178 | Dear Translation Project | |
179 | ||
0d368ae5 | 180 | The 2.42 release branch has been created for the GNU Binutils project. |
79d89b55 NC |
181 | |
182 | A snapshot of the branch sources can be found here: | |
a960d29f | 183 | |
0d368ae5 | 184 | https://sourceware.org/pub/binutils/snapshots/binutils-2.41.90.tar.xz |
a960d29f | 185 | |
b248e9ce | 186 | We hope to make the official release of the sources on the <DATE> |
79d89b55 NC |
187 | although that could change if there are important bugs that need to |
188 | be fixed before the release. | |
189 | ------------------------------------------------------------------------ | |
98ab9e96 | 190 | |
b248e9ce | 191 | 11. Announce the availability of the snapshot and the branch on the |
98ab9e96 | 192 | binutils mailing list. Set a date for when the release will |
7ab82037 | 193 | actually happen. Something like: |
79d89b55 | 194 | |
0d368ae5 | 195 | |
79d89b55 NC |
196 | Hi Everyone, |
197 | ||
b248e9ce | 198 | The <NEW_VERSION> branch has now been created: |
79d89b55 | 199 | |
4b51505e | 200 | git clone git://sourceware.org/git/binutils-gdb.git -b binutils-<NEW_VERSION>-branch |
79d89b55 NC |
201 | |
202 | A snapshot of the sources is also available here: | |
203 | ||
b248e9ce | 204 | https://sourceware.org/pub/binutils/snapshots/binutils-<OLD_VERSION>.90.tar.xz |
79d89b55 NC |
205 | |
206 | Please could all patches for the branch be run by me. | |
207 | The rules for the branch are: | |
208 | ||
209 | * No new features. | |
210 | * Target specific bug fixes are OK. | |
211 | * Generic bug fixes are OK if they are important and widely tested. | |
212 | * Documentation updates/fixes are OK. | |
213 | * Translation updates are OK. | |
214 | * Fixes for testsuite failures are OK. | |
215 | ||
216 | Ideally I would like to make the release happen in two weeks time, | |
b248e9ce | 217 | i.e. <DATE>. Which I hope will be enough time for everyone |
79d89b55 NC |
218 | to get their final fixes in. |
219 | ------------------------------------------------------------------------ | |
220 | ||
b248e9ce | 221 | 12. Build various different toolchains, test them and nag |
7ab82037 NC |
222 | maintainers to fix any testsuite failures for their |
223 | architectures... | |
224 | ||
b248e9ce | 225 | ============================================================================== |
dd78c0a8 NC |
226 | ============================================================================== |
227 | ||
228 | For the next few weeks, monitor the mailing list for new translations | |
229 | and respond to any requests to have patches applied to the branch. | |
230 | ||
231 | ============================================================================== | |
232 | ============================================================================== | |
98ab9e96 | 233 | |
dd78c0a8 | 234 | Then, a couple of weeks later ... |
94c2436b | 235 | |
dd78c0a8 NC |
236 | ------------------------------------------------- |
237 | How to create the release. | |
238 | ------------------------------------------------- | |
94c2436b | 239 | |
9a5db26e | 240 | 20. Make sure that the branch sources still build, test and install |
6cb624f8 NC |
241 | correctly. Make sure that the sources are clean, without any |
242 | patch files (.reg .orig *~) left over. | |
243 | ||
244 | cd <branch> | |
9b351c9b | 245 | git clean -fdx |
9a5db26e | 246 | |
0f38fd87 NC |
247 | 21. a. Update the release number in bfd/version.m4 on the release |
248 | branch to a whole new minor version number, without a point | |
311578da | 249 | value. Eg "2.40.90" becomes "2.41". NB/ Not: "2.41.00" |
5ee285ca | 250 | |
0f38fd87 | 251 | b. Change bfd/development.sh to set all values to "false". |
5ee285ca | 252 | |
0f38fd87 NC |
253 | c. Regenerate the configure and makefiles. And *info* files. |
254 | ||
311578da | 255 | make all-gas all-ld all-binutils all-gprof all-gold all-gprofng all-libctf |
5ee285ca | 256 | make info |
311578da | 257 | |
0f38fd87 NC |
258 | d. Create a ChangeLog from the git refs for all of the commits |
259 | from when changelog entries were no longer required: | |
260 | ||
261 | gitlog-to-changelog --since=2021-07-03 > ChangeLog.git | |
5ee285ca | 262 | git add ChangeLog.git |
0f38fd87 | 263 | |
5ee285ca NC |
264 | The gitlog-to-changelog script is part of the sources |
265 | of the "config" project. | |
15d84284 NC |
266 | |
267 | Add an entry for ChangeLog.git to the src-release.sh script's | |
268 | DEVO_SUPPORT list, so that it is included in the release. | |
269 | ||
270 | FIXME: it would be better if the ChangeLog.git file was permanently | |
271 | added to the src-release.sh script, but this mean that it would have | |
272 | to exist in the master repository, and that the GDB project would | |
273 | need to agree to have it there. | |
0f38fd87 | 274 | |
5ee285ca | 275 | e. Add ChangeLog entries for all of the updates and add a |
311578da | 276 | "this-is-the-2.41-release" comment and commit. |
9a5db26e | 277 | |
311578da | 278 | git add . |
5ee285ca NC |
279 | git commit |
280 | git push | |
281 | ||
9a5db26e NC |
282 | 22. Check that your file creation mask will create the |
283 | correct file permissions. Eg: | |
284 | ||
6cb624f8 NC |
285 | % umask |
286 | 22 | |
287 | ||
288 | Remove any spurious autom4te.cache files left over from the | |
289 | reconfiguring: | |
290 | ||
cb6ad9bb | 291 | git clean -fdx |
9a5db26e | 292 | |
ad96220c NC |
293 | 23. Note - check to see if any new files have been added to the top |
294 | level of the source directory, but which are not in the | |
295 | DEVO_SUPPORT variable in the src-release.sh script. If they are | |
5ee285ca | 296 | needed then add them. |
ad96220c | 297 | |
0f38fd87 | 298 | Create the release tarballs: |
9a5db26e | 299 | |
6cb624f8 | 300 | ./src-release.sh -b -g -l -x binutils |
9a5db26e | 301 | |
f54c53e9 NC |
302 | OR ... for a more reproducible tarball: |
303 | ||
304 | ./src-release.sh -b -g -l -x -r `git log -1 --format=%cd --date=format:%F bfd/version.m4` binutils | |
305 | ||
9a5db26e | 306 | 24. Check that the files in the tarballs have the correct |
07233d96 NC |
307 | permissions. |
308 | ||
311578da | 309 | tar tvf binutils-*.tar.xz | grep -e "---" |
9a5db26e | 310 | |
88ae41e1 NC |
311 | Also check that the man files are not empty. (cf PR 28144). |
312 | ||
5ee285ca | 313 | tar tvf binutils-*.tar.xz | grep -e "\.1" |
88ae41e1 | 314 | |
9a5db26e | 315 | 25. Sanity check the release on x86_64-pc-linux-gnu by building and |
311578da NC |
316 | running the testsuites (gas, gold, binutils and ld). |
317 | Make the source directory read-only before building. | |
318 | Also test 'make install'. | |
319 | Also build the html and pdf documentation files. | |
5ee285ca | 320 | If necessary fix any problems. |
9a5db26e | 321 | |
0f38fd87 | 322 | pushd /dev/shm |
cb6ad9bb NC |
323 | mkdir delme |
324 | cd delme | |
07233d96 | 325 | tar xvf <path-to-sources>/binutils-2.*.tar.lz |
9b351c9b | 326 | chmod -R -w binutils-2.* |
cb6ad9bb NC |
327 | mkdir build |
328 | cd build | |
bb368aad VM |
329 | ../binutils-2.*/configure --quiet --enable-gold --prefix=`pwd`/install --enable-plugins --enable-shared |
330 | make all-gas all-gold all-ld all-binutils all-gprof all-gprofng | |
cb6ad9bb | 331 | make check-gas check-binutils check-ld check-gold |
5ee285ca | 332 | make install-gas install-gold install-ld install-binutils install-gprofng |
cb6ad9bb | 333 | |
bf772a1e | 334 | # Needed for step 29... |
57ffc61c | 335 | make html pdf html-libctf pdf-libctf html-libsframe pdf-libsframe |
bf772a1e | 336 | |
0f38fd87 | 337 | popd |
5ee285ca | 338 | |
9a5db26e | 339 | 26. Tag the branch with the new release number: |
0f38fd87 | 340 | [optional: add "-u XXXXX" to sign with a gpg key] |
311578da | 341 | enter a tag message such as: "Official GNU Binutils 2.4x release" |
9a5db26e | 342 | |
311578da | 343 | git tag -a binutils-2_41 -u DD9E3C4F <=== Be careful to get the tag right |
07233d96 | 344 | |
a8d6d6ac NC |
345 | NB/ If you do sign the binaries make sure to use a key |
346 | that has been published with the FSF. | |
347 | ||
cb6ad9bb NC |
348 | Then push the release: |
349 | ||
311578da | 350 | git push origin binutils-2_41 |
cb6ad9bb | 351 | |
0f38fd87 | 352 | If you get an error message along the lines of: |
311578da NC |
353 | "Invalid revision range ..." |
354 | you can ignore it. | |
cb6ad9bb | 355 | |
0f38fd87 | 356 | 27. Upload the tarballs to ftp.gnu.org. |
9a5db26e | 357 | |
f75c8fc0 | 358 | for A in bz2 gz lz xz ; do gnupload --to ftp.gnu.org:binutils binutils-2.41.tar.$A ; done |
9a5db26e | 359 | |
0f38fd87 NC |
360 | Be prepared to provide the password for the key, if you |
361 | signed the binaries. | |
9b351c9b | 362 | |
0f38fd87 | 363 | The gnupload script is in the gnulib/build-aux directory. |
311578da | 364 | It uses the ncftp package for transmitting the files. |
9a5db26e | 365 | |
0f38fd87 | 366 | Check for an email response from the upload. If necessary |
311578da NC |
367 | fix any problems. (The response might take a while, so |
368 | proceed with the next steps if you are confident that | |
369 | everything is OK). | |
a8d6d6ac | 370 | |
6cb624f8 | 371 | 28. Upload the tarballs (and signatures) to sourceware.org: |
9a5db26e NC |
372 | |
373 | sftp sourceware.org | |
374 | cd /sourceware/ftp/pub/binutils/releases | |
311578da NC |
375 | put binutils-2.4*.tar.* |
376 | chmod 644 binutils-2.4*.tar.* | |
9a5db26e NC |
377 | quit |
378 | ||
0f38fd87 NC |
379 | FIXME: Are the signatures (created by the gnupload script in step 27) |
380 | needed ? [The above commands upload them and nobody has complained, | |
381 | so suggest that they are retained]. | |
9a5db26e | 382 | |
6cb624f8 | 383 | 29. Update web pages. For sourceware.org: |
9a5db26e NC |
384 | |
385 | Create a new documentation folder on the sourceware.org web | |
04d7fa21 | 386 | pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x. |
082cbd3b NC |
387 | |
388 | sftp sourceware.org | |
389 | cd /sourceware/www/sourceware/htdocs/binutils | |
311578da NC |
390 | mkdir docs-2.4x |
391 | cd docs-2.4x | |
07233d96 NC |
392 | mkdir as |
393 | mkdir bfd | |
394 | mkdir binutils | |
395 | mkdir gprof | |
396 | mkdir ld | |
04d7fa21 | 397 | cd ../docs-2.3(x-1) |
082cbd3b NC |
398 | get index.html |
399 | ||
400 | Update the (local copy of the) index.html file to point to the | |
401 | new documentation and mention the new version and then upload it. | |
402 | ||
311578da | 403 | cd ../docs-2.4x |
082cbd3b NC |
404 | put index.html |
405 | ||
311578da NC |
406 | Make the html documentation locally with the "make html" command. |
407 | (This should have been done by step 25 above). | |
408 | Then upload and rename the directories as needed. | |
409 | (Sftp does not support recursive uploads however, so the directories | |
410 | have to be made and populated by hand). | |
082cbd3b NC |
411 | |
412 | cd as | |
07233d96 NC |
413 | lcd <build-dir>/gas/doc/as |
414 | put * {be patient - this takes a long time...} | |
415 | lcd .. | |
416 | cd .. | |
354c317e MF |
417 | put as.html |
418 | put as.pdf | |
1da0b075 | 419 | |
0f38fd87 | 420 | cd bfd |
07233d96 NC |
421 | lcd ../../bfd/doc/bfd |
422 | put * | |
423 | cd .. | |
424 | lcd .. | |
354c317e MF |
425 | put bfd.html |
426 | put bfd.pdf | |
1da0b075 | 427 | |
0f38fd87 NC |
428 | cd binutils |
429 | lcd ../../binutils/binutils <=== NB/ Path not like others | |
07233d96 NC |
430 | put * |
431 | cd .. | |
311578da | 432 | lcd ../doc <=== Also not like the others |
354c317e MF |
433 | put binutils.html |
434 | put binutils.pdf | |
1da0b075 | 435 | |
0f38fd87 | 436 | cd gprof |
07233d96 NC |
437 | lcd ../../gprof/doc/gprof |
438 | put * | |
439 | cd .. | |
311578da | 440 | lcd ../.. <==== Different again |
354c317e MF |
441 | put gprof.html |
442 | put gprof.pdf | |
1da0b075 | 443 | |
0f38fd87 | 444 | cd ld |
07233d96 NC |
445 | lcd ../ld/doc/ld |
446 | put * | |
447 | cd .. | |
448 | lcd ../.. | |
354c317e MF |
449 | put ld.html |
450 | put ld.pdf | |
082cbd3b | 451 | |
311578da | 452 | lcd ../gprofng/doc |
1da0b075 NC |
453 | put gprofng.html |
454 | put gprofng.pdf | |
455 | ||
311578da NC |
456 | lcd ../../libctf/doc |
457 | put ctf-spec.html | |
458 | put ctf-spec.pdf | |
57ffc61c IB |
459 | |
460 | lcd ../../libsframe/doc | |
461 | put sframe-spec.html | |
462 | put sframe-spec.pdf | |
311578da | 463 | |
082cbd3b | 464 | Edit the top level binutils index.html file to change the links |
cb6ad9bb | 465 | to point to the new documentation. |
082cbd3b | 466 | |
bf772a1e | 467 | cd ../.. |
04d7fa21 | 468 | get index.html |
082cbd3b | 469 | [edit] |
311578da | 470 | [check that it works] |
082cbd3b | 471 | put index.html |
624a2451 | 472 | rm docs |
311578da | 473 | ln -s docs-2.4x docs |
082cbd3b NC |
474 | quit |
475 | ||
bf772a1e NC |
476 | Check that the new web page is correct: |
477 | ||
478 | https://sourceware.org/binutils/ | |
479 | ||
9a5db26e | 480 | For the www.gnu.org site you have to email webmasters@gnu.org |
311578da | 481 | and ask them to copy the change(s): |
bf772a1e NC |
482 | --------------------------------------- |
483 | Hi FSF Webmasters, | |
484 | ||
485 | Please could the GNU Binutils webpage at: | |
486 | ||
487 | https://www.gnu.org/software/binutils/binutils.html | |
488 | ||
489 | be updated to indicate that there is now a newer version available | |
490 | (2.3x). I have already updated the related page on the sourceware | |
491 | website so this might be useful as a template: | |
492 | ||
493 | https://sourceware.org/binutils/ | |
494 | ||
495 | Thanks very much. | |
496 | ||
497 | Cheers | |
498 | -------------------------------------- | |
9a5db26e | 499 | |
6cb624f8 | 500 | 30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and |
9a5db26e | 501 | David Edelsohn <dje.gcc@gmail.com> announcing the new release. |
03d0d46a NC |
502 | Sign the email and include the checksum: |
503 | ||
311578da | 504 | sha256sum binutils-2.4*.tar.* |
03d0d46a | 505 | |
9a5db26e NC |
506 | (The email to Davis is so that he can update the GNU Toolchain |
507 | social media). Something like this: | |
082cbd3b | 508 | ----------------------------------------------------------------------- |
9a5db26e NC |
509 | Hi Everyone, |
510 | ||
311578da | 511 | We are pleased to announce that version 2.4x of the GNU Binutils project |
9a5db26e NC |
512 | sources have been released and are now available for download at: |
513 | ||
514 | https://ftp.gnu.org/gnu/binutils | |
515 | https://sourceware.org/pub/binutils/releases/ | |
516 | ||
517 | checksums: xxxx | |
94c2436b | 518 | |
311578da NC |
519 | As an experiment these tarballs were made with the new "-r <date>" |
520 | option supported by the src-release.sh script. This attempts to make | |
521 | reproducible tarballs by sorting the files and passing the | |
522 | "--mtime=<date>" option to tar. The date used for these tarballs was | |
523 | obtained by running: | |
524 | ||
525 | git log -1 --format=%cd --date=format:%F bfd/version.m4 | |
526 | ||
cb6ad9bb NC |
527 | This release contains numerous bug fixes, and also the |
528 | following new features: | |
78b2179a | 529 | |
9a5db26e | 530 | <extract info from the NEWS files> |
94c2436b | 531 | |
e838f9c2 NC |
532 | For more information see: |
533 | ||
311578da NC |
534 | https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=gas/NEWS;;hb=refs/tags/binutils-2_4x |
535 | https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=ld/NEWS;hb=refs/tags/binutils-2_4x | |
536 | https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=binutils/NEWS;hb=refs/tags/binutils-2_4x | |
e838f9c2 | 537 | |
cb6ad9bb NC |
538 | Our thanks go out to all of the binutils contributors, past and |
539 | present, for helping to make this release possible. | |
94c2436b | 540 | |
082cbd3b | 541 | ----------------------------------------------------------------------- |
94c2436b | 542 | |
04d7fa21 NC |
543 | 31. Clean up the source tree: |
544 | ||
545 | git clean -fdx . | |
082cbd3b NC |
546 | |
547 | 32. Edit bfd/development.sh on the branch and set the development flag | |
548 | to "true". (Leave the experimental flag set to "false"). Also bump | |
549 | the version in bfd/version.m4 by adding a trailing .0, so that the | |
550 | date suffix keeps the version lower than the trunk version. | |
551 | Regenerate files. Commit these changes. | |
6cb624f8 | 552 | |
311578da | 553 | 33. Email the binutils list telling everyone that the 2.34 branch |
bf772a1e | 554 | is now open for business as usual and that patches no longer |
6cb624f8 | 555 | need special approval. |
2012bf01 | 556 | |
cb6ad9bb NC |
557 | 34. Examine the bfd/config.bfd file in the mainline sources and move |
558 | any pending obsolete targets into the definitely obsolete | |
559 | section. Create a changelog entry and commit. | |
a315d390 NC |
560 | |
561 | ||
cb6ad9bb | 562 | -------------------------------------------------------------------------- |
a315d390 | 563 | How to perform a POINT release. |
cb6ad9bb | 564 | -------------------------------------------------------------------------- |
78b2179a NC |
565 | |
566 | A point release is easier than a normal release since a lot of the | |
567 | work has already been done. The branch has been created, the | |
568 | translations updated and the documentation uploaded. So the procedure | |
569 | looks like this: | |
570 | ||
571 | 0. Decide that a point release is necessary. | |
572 | ||
573 | Usually this only happens when a sufficient number of serious | |
574 | bugs have been found and fixed since the previous release, and a | |
575 | new official release is not imminent. | |
576 | ||
577 | 1. Tell the community that a point release is happening. Ask | |
578 | maintainers to ensure that their ports are up to date on the | |
579 | release branch. Ask the community if there are any bug fixes | |
580 | which are missing from the branch. Allow some time for the | |
581 | responses to this step. | |
582 | ||
583 | 2. Make sure that the branch sources build, test and install | |
584 | correctly. | |
585 | ||
98ab9e96 NC |
586 | 2.5 Prepare a list of the bugs which have been fixed. This |
587 | will be needed for step 8. | |
a960d29f | 588 | |
ef336cb0 | 589 | 3. In the branch sources: |
a960d29f | 590 | |
ef336cb0 | 591 | a. Update the minor release number in bfd/version.m4. |
04d7fa21 | 592 | b. Edit bfd/development.sh, set "development=false". |
ef336cb0 | 593 | c. Regenerate the configure files. |
72a51a06 | 594 | d. Remove spurious autom4te.cache files: |
442a6ce8 | 595 | |
72a51a06 | 596 | git clean -fdx |
442a6ce8 | 597 | |
72a51a06 | 598 | e. Commit the updates along with a "this-is-the-2.3x.y-release" |
ef336cb0 | 599 | note in all of the changelogs. |
72a51a06 | 600 | f. Tag the branch with the new release number: |
ef336cb0 | 601 | |
04d7fa21 | 602 | git tag -a binutils-2_3x_y |
ef336cb0 | 603 | [optional: add "-u XXXXX" to sign with a gpg key] |
04d7fa21 | 604 | git push origin binutils-2_3x_y |
ef336cb0 | 605 | |
72a51a06 NC |
606 | g. Check that your file creation mask will create the |
607 | correct file permissions. Ie: | |
8071ec09 NC |
608 | |
609 | umask 022 | |
a960d29f | 610 | |
72a51a06 | 611 | h. Create the release tarballs: |
04d7fa21 | 612 | |
ef336cb0 | 613 | ./src-release -b -g -l -x binutils |
8071ec09 | 614 | |
72a51a06 | 615 | i. Check that the files in the tarballs have the correct |
8071ec09 | 616 | permissions. |
a960d29f | 617 | |
72a51a06 NC |
618 | j. Clean the source tree again |
619 | ||
620 | git clean -fdx | |
621 | ||
622 | k. Edit bfd/development.sh and set "development=true". | |
623 | l. Commit this change. | |
78b2179a | 624 | |
ef336cb0 NC |
625 | 4. [If paranoid - upload the tarballs to one of the FTP servers and |
626 | ask people to test it before going on to step 5]. | |
a960d29f | 627 | |
ef336cb0 | 628 | 5. Upload the tarballs to ftp.gnu.org. |
78b2179a | 629 | |
72a51a06 | 630 | gnupload --to ftp.gnu.org:binutils binutils-*.tar.* |
78b2179a | 631 | |
ef336cb0 | 632 | The gnupload script is in the gnulib/build-aux directory. |
78b2179a | 633 | |
ef336cb0 | 634 | 6. Upload the tarballs to sourceware.org: |
78b2179a NC |
635 | |
636 | sftp sourceware.org | |
442a6ce8 | 637 | cd /sourceware/ftp/pub/binutils/releases |
72a51a06 NC |
638 | put binutils-*.tar.* |
639 | chmod 644 binutils-*.tar.* | |
78b2179a NC |
640 | quit |
641 | ||
442a6ce8 | 642 | It is OK to upload the signatures as well. |
78b2179a | 643 | |
ef336cb0 | 644 | 7. Update web pages. For sourceware.org: |
78b2179a NC |
645 | |
646 | * Log on to sourceware.org | |
442a6ce8 | 647 | * Go to /sourceware/www/sourceware/htdocs/binutils |
72a51a06 | 648 | * Edit index.html and update the latest release number (if this is a latest release) |
78b2179a NC |
649 | |
650 | For the www.gnu.org site you have to email webmasters@gnu.org | |
651 | and ask them to make the change(s). | |
652 | ||
ef336cb0 NC |
653 | 8. Send an emails to the binutils list, info-gnu@gnu.org and |
654 | David Edelsohn <dje.gcc@gmail.com> announcing the new release. | |
655 | (The email to Davis is so that he can update the GNU Toolchain | |
656 | social media). Something like this: | |
03d0d46a | 657 | |
78b2179a NC |
658 | ------------------------------------------------------------------------ |
659 | Hi Everyone, | |
660 | ||
04d7fa21 | 661 | We are pleased to announce that version 2.3x.y of the GNU Binutils |
442a6ce8 | 662 | project sources have been released and are now available for download at: |
a960d29f | 663 | |
78b2179a NC |
664 | https://ftp.gnu.org/gnu/binutils |
665 | https://sourceware.org/pub/binutils/releases/ | |
666 | ||
04d7fa21 | 667 | This is a point release over the previous 2.3x version, containing bug |
78b2179a NC |
668 | fixes but no new features. |
669 | ||
670 | Our thanks go out to all of the binutils contributors, past and | |
671 | present, for helping to make this release possible. | |
98ab9e96 NC |
672 | |
673 | Here is a list of the bugs that have been fixed: | |
674 | xx | |
675 | xx | |
676 | xx | |
677 | xx | |
78b2179a | 678 | -------------------------------------------------------------------------- |
a315d390 NC |
679 | |
680 | 9. Create a new Bugzilla entry for the point release. | |
681 | ||
682 | https://sourceware.org/bugzilla/editversions.cgi?product=binutils | |
683 | ||
684 | And a new milestone too: | |
685 | ||
686 | https://sourceware.org/bugzilla/editmilestones.cgi?product=binutils | |
78b2179a | 687 | \f |
d87bef3a | 688 | Copyright (C) 2017-2023 Free Software Foundation, Inc. |
78b2179a NC |
689 | |
690 | Copying and distribution of this file, with or without modification, | |
691 | are permitted in any medium without royalty provided the copyright | |
692 | notice and this notice are preserved. |