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