|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | - | - |
| doc/ | H | - | - | 15,513 | 13,758 |
| po/ | H | - | - | 251,346 | 205,018 |
| BRANCHES | H A D | 29-Jun-2024 | 1.8 KiB | 65 | 56 |
| ChangeLog | H A D | 29-Jun-2024 | 59.7 KiB | 1,866 | 1,365 |
| ChangeLog-0001 | H A D | 14-Apr-2018 | 63.1 KiB | 2,067 | 1,457 |
| ChangeLog-0203 | H A D | 14-Apr-2018 | 66.8 KiB | 2,188 | 1,542 |
| ChangeLog-2004 | H A D | 14-Apr-2018 | 25.6 KiB | 800 | 572 |
| ChangeLog-2005 | H A D | 14-Apr-2018 | 43 KiB | 1,357 | 984 |
| ChangeLog-2006 | H A D | 14-Apr-2018 | 18.5 KiB | 606 | 425 |
| ChangeLog-2007 | H A D | 14-Apr-2018 | 36.7 KiB | 1,172 | 841 |
| ChangeLog-2008 | H A D | 14-Apr-2018 | 28.2 KiB | 881 | 631 |
| ChangeLog-2009 | H A D | 14-Apr-2018 | 43.6 KiB | 1,362 | 999 |
| ChangeLog-2010 | H A D | 14-Apr-2018 | 32.2 KiB | 1,084 | 771 |
| ChangeLog-2011 | H A D | 29-Jun-2024 | 30.4 KiB | 937 | 699 |
| ChangeLog-2012 | H A D | 14-Apr-2018 | 23 KiB | 757 | 549 |
| ChangeLog-2013 | H A D | 14-Apr-2018 | 21.1 KiB | 682 | 486 |
| ChangeLog-2014 | H A D | 14-Apr-2018 | 31.2 KiB | 961 | 701 |
| ChangeLog-2015 | H A D | 14-Apr-2018 | 32.1 KiB | 1,035 | 748 |
| ChangeLog-2016 | H A D | 03-Apr-2020 | 32 KiB | 989 | 715 |
| ChangeLog-2017 | H A D | 29-Jun-2024 | 62.9 KiB | 1,887 | 1,418 |
| ChangeLog-2018 | H A D | 23-Dec-2022 | 51.1 KiB | 1,559 | 1,138 |
| ChangeLog-2019 | H A D | 23-Dec-2022 | 50 KiB | 1,526 | 1,134 |
| ChangeLog-2020 | H A D | 29-Jun-2024 | 68.4 KiB | 2,081 | 1,532 |
| ChangeLog-9197 | H A D | 14-Apr-2018 | 188 KiB | 5,224 | 3,780 |
| ChangeLog-9899 | H A D | 14-Apr-2018 | 63.8 KiB | 1,915 | 1,382 |
| MAINTAINERS | H A D | 29-Jun-2024 | 12.4 KiB | 318 | 253 |
| Makefile.am | H A D | 29-Jun-2024 | 20.3 KiB | 571 | 407 |
| Makefile.in | H A D | 29-Jun-2024 | 84 KiB | 2,153 | 1,761 |
| NEWS | H A D | 29-Jun-2024 | 34.1 KiB | 862 | 588 |
| README | H A D | 29-Jun-2024 | 11.2 KiB | 301 | 219 |
| README-how-to-make-a-release | H A D | 29-Jun-2024 | 18.8 KiB | 595 | 411 |
| aclocal.m4 | H A D | 29-Jun-2024 | 43.6 KiB | 1,213 | 1,104 |
| addr2line.c | H A D | 29-Jun-2024 | 14.9 KiB | 581 | 434 |
| ar.c | H A D | 29-Jun-2024 | 42.3 KiB | 1,641 | 1,178 |
| arlex.c | H A D | 29-Jun-2024 | 52.4 KiB | 2,043 | 1,335 |
| arlex.l | H A D | 29-Jun-2024 | 2.3 KiB | 91 | 58 |
| arparse.c | H A D | 29-Jun-2024 | 49.9 KiB | 1,598 | 1,052 |
| arparse.h | H A D | 29-Jun-2024 | 3.8 KiB | 128 | 74 |
| arparse.y | H A D | 29-Jun-2024 | 3.1 KiB | 203 | 142 |
| arsup.c | H A D | 29-Jun-2024 | 10 KiB | 515 | 406 |
| arsup.h | H A D | 29-Jun-2024 | 1.5 KiB | 63 | 22 |
| bfdtest1.c | H A D | 29-Jun-2024 | 1.7 KiB | 71 | 41 |
| bfdtest2.c | H A D | 29-Jun-2024 | 2.5 KiB | 107 | 66 |
| bin2c.c | H A D | 29-Jun-2024 | 1.6 KiB | 67 | 39 |
| binemul.c | H A D | 29-Jun-2024 | 3.9 KiB | 170 | 116 |
| binemul.h | H A D | 29-Jun-2024 | 2.4 KiB | 67 | 34 |
| bucomm.c | H A D | 29-Jun-2024 | 16.9 KiB | 718 | 520 |
| bucomm.h | H A D | 29-Jun-2024 | 2.5 KiB | 94 | 37 |
| budbg.h | H A D | 29-Jun-2024 | 1.7 KiB | 52 | 14 |
| coffdump.c | H A D | 29-Jun-2024 | 10.9 KiB | 557 | 476 |
| coffgrok.c | H A D | 29-Jun-2024 | 22.5 KiB | 906 | 745 |
| coffgrok.h | H A D | 29-Jun-2024 | 4.8 KiB | 222 | 175 |
| config.in | H A D | 29-Jun-2024 | 7.1 KiB | 266 | 188 |
| configure | H A D | 29-Jun-2024 | 497.9 KiB | 17,374 | 14,670 |
| configure.ac | H A D | 29-Jun-2024 | 15.5 KiB | 559 | 488 |
| configure.com | H A D | 29-Jun-2024 | 4.6 KiB | 147 | 139 |
| configure.tgt | H A D | 29-Jun-2024 | 1.4 KiB | 43 | 37 |
| cxxfilt.c | H A D | 29-Jun-2024 | 6.9 KiB | 261 | 197 |
| debug.c | H A D | 29-Jun-2024 | 85.1 KiB | 3,384 | 2,353 |
| debug.h | H A D | 29-Jun-2024 | 28.6 KiB | 790 | 211 |
| deflex.c | H A D | 29-Jun-2024 | 53.3 KiB | 2,070 | 1,361 |
| deflex.l | H A D | 29-Jun-2024 | 2.4 KiB | 92 | 61 |
| defparse.c | H A D | 29-Jun-2024 | 65.6 KiB | 2,017 | 1,427 |
| defparse.h | H A D | 29-Jun-2024 | 4.6 KiB | 150 | 97 |
| defparse.y | H A D | 29-Jun-2024 | 5.6 KiB | 245 | 192 |
| demanguse.c | H A D | 29-Jun-2024 | 1.7 KiB | 55 | 28 |
| demanguse.h | H A D | 29-Jun-2024 | 1 KiB | 35 | 10 |
| dep-in.sed | H A D | 14-Apr-2018 | 257 | 21 | 18 |
| dlltool.c | H A D | 29-Jun-2024 | 113 KiB | 4,310 | 3,142 |
| dlltool.h | H A D | 29-Jun-2024 | 1.5 KiB | 40 | 18 |
| dllwrap.c | H A D | 29-Jun-2024 | 33.7 KiB | 1,256 | 968 |
| dwarf-mode.el | H A D | 29-Jun-2024 | 8 KiB | 232 | 155 |
| dwarf.c | H A D | 29-Jun-2024 | 339.5 KiB | 12,366 | 10,076 |
| dwarf.h | H A D | 29-Jun-2024 | 9.2 KiB | 338 | 256 |
| elfcomm.c | H A D | 29-Jun-2024 | 22.5 KiB | 816 | 609 |
| elfcomm.h | H A D | 29-Jun-2024 | 4.2 KiB | 102 | 47 |
| elfedit.c | H A D | 29-Jun-2024 | 28.1 KiB | 1,106 | 895 |
| embedspu.sh | H A D | 29-Jun-2024 | 8.4 KiB | 261 | 202 |
| emul_aix.c | H A D | 29-Jun-2024 | 3.2 KiB | 131 | 89 |
| emul_vanilla.c | H A D | 29-Jun-2024 | 1.1 KiB | 31 | 8 |
| filemode.c | H A D | 29-Jun-2024 | 6 KiB | 249 | 157 |
| is-ranlib.c | H A D | 29-Jun-2024 | 915 | 23 | 1 |
| is-strip.c | H A D | 29-Jun-2024 | 926 | 24 | 1 |
| makefile.vms | H A D | 29-Jun-2024 | 2.5 KiB | 91 | 46 |
| maybe-ranlib.c | H A D | 29-Jun-2024 | 959 | 24 | 1 |
| maybe-strip.c | H A D | 29-Jun-2024 | 967 | 24 | 1 |
| mclex.c | H A D | 29-Jun-2024 | 10.6 KiB | 463 | 396 |
| mcparse.c | H A D | 29-Jun-2024 | 64.2 KiB | 2,015 | 1,427 |
| mcparse.h | H A D | 29-Jun-2024 | 4 KiB | 129 | 76 |
| mcparse.y | H A D | 29-Jun-2024 | 8.4 KiB | 357 | 293 |
| nm.c | H A D | 29-Jun-2024 | 55.9 KiB | 2,206 | 1,726 |
| not-ranlib.c | H A D | 29-Jun-2024 | 915 | 23 | 1 |
| not-strip.c | H A D | 29-Jun-2024 | 926 | 24 | 1 |
| objcopy.c | H A D | 29-Jun-2024 | 167.8 KiB | 6,064 | 4,664 |
| objdump.c | H A D | 29-Jun-2024 | 153.2 KiB | 5,934 | 4,555 |
| objdump.h | H A D | 29-Jun-2024 | 1.7 KiB | 54 | 15 |
| od-elf32_avr.c | H A D | 29-Jun-2024 | 9.9 KiB | 365 | 275 |
| od-macho.c | H A D | 29-Jun-2024 | 68.9 KiB | 2,306 | 2,043 |
| od-xcoff.c | H A D | 29-Jun-2024 | 51 KiB | 1,844 | 1,545 |
| prdbg.c | H A D | 29-Jun-2024 | 59.8 KiB | 2,801 | 2,092 |
| ranlib.sh | H A D | 29-Jun-2024 | 902 | 23 | 1 |
| rclex.c | H A D | 29-Jun-2024 | 18 KiB | 905 | 723 |
| rcparse.c | H A D | 29-Jun-2024 | 157.2 KiB | 4,797 | 3,979 |
| rcparse.h | H A D | 29-Jun-2024 | 10.2 KiB | 326 | 272 |
| rcparse.y | H A D | 29-Jun-2024 | 40.3 KiB | 2,022 | 1,761 |
| rdcoff.c | H A D | 29-Jun-2024 | 20.9 KiB | 885 | 664 |
| rddbg.c | H A D | 29-Jun-2024 | 10.3 KiB | 438 | 314 |
| readelf.c | H A D | 29-Jun-2024 | 610.6 KiB | 22,866 | 19,202 |
| rename.c | H A D | 29-Jun-2024 | 5.9 KiB | 229 | 162 |
| resbin.c | H A D | 29-Jun-2024 | 55.3 KiB | 2,166 | 1,675 |
| rescoff.c | H A D | 29-Jun-2024 | 21.6 KiB | 768 | 492 |
| resrc.c | H A D | 29-Jun-2024 | 82.6 KiB | 3,397 | 2,622 |
| resres.c | H A D | 29-Jun-2024 | 19.7 KiB | 731 | 545 |
| sanity.sh | H A D | 29-Jun-2024 | 1.6 KiB | 68 | 25 |
| size.c | H A D | 29-Jun-2024 | 15.6 KiB | 663 | 512 |
| srconv.c | H A D | 29-Jun-2024 | 38.7 KiB | 1,853 | 1,469 |
| stabs.c | H A D | 29-Jun-2024 | 133.9 KiB | 5,559 | 4,115 |
| strings.c | H A D | 29-Jun-2024 | 31.9 KiB | 1,346 | 960 |
| sysdep.h | H A D | 29-Jun-2024 | 3.3 KiB | 140 | 95 |
| sysdump.c | H A D | 29-Jun-2024 | 12 KiB | 721 | 565 |
| sysinfo.c | H A D | 29-Jun-2024 | 51.7 KiB | 1,787 | 1,241 |
| sysinfo.h | H A D | 29-Jun-2024 | 3 KiB | 103 | 50 |
| sysinfo.y | H A D | 29-Jun-2024 | 8.2 KiB | 442 | 357 |
| syslex.c | H A D | 29-Jun-2024 | 48.1 KiB | 1,908 | 1,214 |
| syslex.l | H A D | 29-Jun-2024 | 1.9 KiB | 75 | 45 |
| syslex_wrap.c | H A D | 29-Jun-2024 | 933 | 26 | 4 |
| sysroff.info | H A D | 14-Apr-2018 | 14.9 KiB | 505 | 431 |
| unwind-ia64.c | H A D | 29-Jun-2024 | 28 KiB | 1,165 | 952 |
| unwind-ia64.h | H A D | 29-Jun-2024 | 1.3 KiB | 33 | 9 |
| version.c | H A D | 29-Jun-2024 | 1.5 KiB | 41 | 14 |
| windint.h | H A D | 29-Jun-2024 | 26.3 KiB | 1,098 | 769 |
| windmc.c | H A D | 29-Jun-2024 | 29.8 KiB | 1,169 | 964 |
| windmc.h | H A D | 29-Jun-2024 | 2.6 KiB | 100 | 55 |
| windres.c | H A D | 29-Jun-2024 | 32.1 KiB | 1,416 | 1,074 |
| windres.h | H A D | 29-Jun-2024 | 5.7 KiB | 123 | 75 |
| winduni.c | H A D | 29-Jun-2024 | 23.2 KiB | 908 | 708 |
| winduni.h | H A D | 29-Jun-2024 | 4.4 KiB | 140 | 59 |
| wrstabs.c | H A D | 29-Jun-2024 | 54.3 KiB | 2,287 | 1,620 |
README
1 README for BINUTILS
2
3These are the GNU binutils. These are utilities of use when dealing
4with binary files, either object files or executables. These tools
5consist of the linker (ld), the assembler (gas), and the profiler
6(gprof) each of which have their own sub-directory named after them.
7There is also a collection of other binary tools, including the
8disassembler (objdump) in this directory. These tools make use of a
9pair of libraries (bfd and opcodes) and a common set of header files
10(include).
11
12There are README and NEWS files in most of the program sub-directories
13which give more information about those specific programs.
14
15
16Copyright Notices
17=================
18
19Copyright years on binutils source files may be listed using range
20notation, e.g., 1991-2021, indicating that every year in the range,
21inclusive, is a copyrightable year that could otherwise be listed
22individually.
23
24
25Unpacking and Installation -- quick overview
26============================================
27
28When you unpack the binutils archive file, you will get a directory
29called something like `binutils-XXX', where XXX is the number of the
30release. (Probably 2.36 or higher). This directory contains
31various files and sub-directories. Most of the files in the top
32directory are for information and for configuration. The actual
33source code is in sub-directories.
34
35To build binutils you will need a C99 compliant compiler and library.
36You can just do:
37
38 cd binutils-XXX
39 ./configure [options]
40 make
41 make install # copies the programs files into /usr/local/bin
42 # by default.
43
44This will configure and build all the libraries as well as the
45assembler, the binutils, and the linker.
46
47If you have GNU make, we recommend building in a different directory:
48
49 mkdir objdir
50 cd objdir
51 ../binutils-XXX/configure [options]
52 make
53 make install
54
55This relies on the VPATH feature of GNU make.
56
57By default, the binutils will be configured to support the system on
58which they are built. When doing cross development, use the --target
59configure option to specify a different target, eg:
60
61 ./configure --target=powerpc64le-linux
62
63The --enable-targets option adds support for more binary file formats
64besides the default. List them as the argument to --enable-targets,
65separated by commas. For example:
66
67 ./configure --enable-targets=powerpc-linux,rs6000-aix
68
69The name 'all' compiles in support for all valid BFD targets:
70
71 ./configure --enable-targets=all
72
73On 32-bit hosts though, this support will be restricted to 32-bit
74target unless the --enable-64-bit-bfd option is also used:
75
76 ./configure --enable-64-bit-bfd --enable-targets=all
77
78You can also specify the --enable-shared option when you run
79configure. This will build the BFD and opcodes libraries as shared
80libraries. You can use arguments with the --enable-shared option to
81indicate that only certain libraries should be built shared; for
82example, --enable-shared=bfd. The only potential shared libraries in
83a binutils release are bfd and opcodes.
84
85The binutils will be linked against the shared libraries. The build
86step will attempt to place the correct library in the run-time search
87path for the binaries. However, in some cases, after you install the
88binaries, you may have to set an environment variable, normally
89LD_LIBRARY_PATH, so that the system can find the installed libbfd
90shared library.
91
92On hosts that support shared system libraries the binutils will be
93linked against them. If you have static versions of the system
94libraries installed as well and you wish to create static binaries
95instead then use the LDFLAGS environment variable, like this:
96
97 ../binutils-XXX/configure LDFLAGS="--static" [more options]
98
99Note: the two dashes are important. The binutils make use of the
100libtool script which has a special interpretation of "-static" when it
101is in the LDFLAGS environment variable.
102
103To build under openVMS/AXP, see the file makefile.vms in the top level
104directory.
105
106
107Native Language Support
108=======================
109
110By default Native Language Support will be enabled for binutils. On
111some systems however this support is not present and can lead to error
112messages such as "undefined reference to `libintl_gettext'" when
113building there tools. If that happens the NLS support can be disabled
114by adding the --disable-nls switch to the configure line like this:
115
116 ../binutils-XXX/configure --disable-nls
117
118
119If you don't have ar
120====================
121
122If your system does not already have an 'ar' program, the normal
123binutils build process will not work. In this case, run configure as
124usual. Before running make, run this script:
125
126#!/bin/sh
127MAKE_PROG="${MAKE-make}"
128MAKE="${MAKE_PROG} AR=true LINK=true"
129export MAKE
130${MAKE} $* all-libiberty
131${MAKE} $* all-intl
132${MAKE} $* all-bfd
133cd binutils
134MAKE="${MAKE_PROG}"
135export MAKE
136${MAKE} $* ar_DEPENDENCIES= ar_LDADD='../bfd/*.o ../libiberty/*.o `if test -f ../intl/gettext.o; then echo '../intl/*.o'; fi`' ar
137
138This script will build an ar program in binutils/ar. Move binutils/ar
139into a directory on your PATH. After doing this, you can run make as
140usual to build the complete binutils distribution. You do not need
141the ranlib program in order to build the distribution.
142
143Porting
144=======
145
146Binutils-2.36 supports many different architectures, but there
147are many more not supported, including some that were supported
148by earlier versions. We are hoping for volunteers to improve this
149situation.
150
151The major effort in porting binutils to a new host and/or target
152architecture involves the BFD library. There is some documentation
153in ../bfd/doc. The file ../gdb/doc/gdbint.texinfo (distributed
154with gdb-5.x) may also be of help.
155
156Reporting bugs
157==============
158
159Please report bugs via
160
161 https://sourceware.org/bugzilla/enter_bug.cgi?product=binutils
162
163Please include the following in bug reports:
164
165- A description of exactly what went wrong, and exactly what should have
166 happened instead.
167
168- The configuration name(s) given to the "configure" script. The
169 "config.status" file should have this information. This is assuming
170 you built binutils yourself. If you didn't build binutils youself,
171 then we need information regarding your machine and operating system,
172 and it may be more appropriate to report bugs to wherever you obtained
173 binutils.
174
175- The options given to the tool (gas, objcopy, ld etc.) at run time.
176
177- The actual input file that caused the problem.
178
179Always mention the version number you are running; this is printed by
180running any of the binutils with the --version option. We appreciate
181reports about bugs, but we do not promise to fix them, particularly so
182when the bug report is against an old version. If you are able, please
183consider building the latest tools from git to check that your bug has
184not already been fixed.
185
186When reporting problems about gas and ld, it's useful to provide a
187testcase that triggers the problem. In the case of a gas problem, we
188want input files to gas and command line switches used. The inputs to
189gas are _NOT_ .c or .i files, but rather .s files. If your original
190source was a C program, you can generate the .s file and see the command
191line options by passing -v -save-temps to gcc in addition to all the
192usual options you use. The reason we don't want C files is that we
193might not have a C compiler around for the target you use. While it
194might be possible to build a compiler, that takes considerable time and
195disk space, and we might not end up with exactly the same compiler you
196use.
197
198In the case of a ld problem, the input files are .o, .a and .so files,
199and possibly a linker script specified with -T. Again, when using gcc
200to link, you can see these files by adding options to the gcc command
201line. Use -v -save-temps -Wl,-t, except that on targets that use gcc's
202collect2, you would add -v -save-temps -Wl,-t,-debug. The -t option
203tells ld to print all files and libraries used, so that, for example,
204you can associate -lc on the ld command line with the actual libc used.
205Note that your simple two line C program to trigger a problem typically
206expands into several megabytes of objects by the time you include
207libraries.
208
209There is a limit to the size of attachments accepted by bugzilla. If
210compressing your testcase does not result in an acceptable size tar or
211zip file, please put large testcases somewhere on an ftp or web site.
212Better still, try to reduce the testcase, for example, try to develop
213a ld testcase that doesn't use system libraries. However, please be
214sure it is a complete testcase and that it really does demonstrate the
215problem. Also, don't bother paring it down if that will cause large
216delays in filing the bug report.
217
218If you expect to be contributing a large number of test cases, it would
219be helpful if you would look at the test suite included in the release
220(based on the Deja Gnu testing framework, available from the usual ftp
221sites) and write test cases to fit into that framework. This is
222certainly not required.
223
224VMS
225===
226
227This section was written by Klaus K"ampf <kkaempf@rmi.de>. It
228describes how to build and install the binutils on openVMS (Alpha and
229Vax). (The BFD library only supports reading Vax object files.)
230
231Compiling the release:
232
233To compile the gnu binary utilities and the gnu assembler, you'll
234need DEC C or GNU C for openVMS/Alpha. You'll need *both* compilers
235on openVMS/Vax.
236
237Compiling with either DEC C or GNU C works on openVMS/Alpha only. Some
238of the opcodes and binutils files trap a bug in the DEC C optimizer,
239so these files must be compiled with /noopt.
240
241Compiling on openVMS/Vax is a bit complicated, as the bfd library traps
242a bug in GNU C and the gnu assembler a bug in (my version of) DEC C.
243
244I never tried compiling with VAX C.
245
246
247You further need GNU Make Version 3.76 or later. This is available
248at ftp.progis.de or any GNU archive site. The makefiles assume that
249gmake starts gnu make as a foreign command.
250
251If you're compiling with DEC C or VAX C, you must run
252
253 $ @setup
254
255before starting gnu-make. This isn't needed with GNU C.
256
257On the Alpha you can choose the compiler by editing the toplevel
258makefile.vms. Either select CC=cc (for DEC C) or CC=gcc (for GNU C)
259
260
261Installing the release
262
263Provided that your directory setup conforms to the GNU on openVMS
264standard, you already have a concealed device named 'GNU_ROOT'.
265In this case, a simple
266
267 $ gmake install
268
269suffices to copy all programs and libraries to the proper directories.
270
271Define the programs as foreign commands by adding these lines to your
272login.com:
273
274 $ gas :== $GNU_ROOT:[bin]as.exe
275 $ size :== $GNU_ROOT:[bin]size.exe
276 $ nm :== $GNU_ROOT:[bin]nm.exe
277 $ objdump :== $GNU_ROOT:[bin]objdump.exe
278 $ strings :== $GNU_ROOT:[bin]strings.exe
279
280If you have a different directory setup, copy the binary utilities
281([.binutils]size.exe, [.binutils]nm.exe, [.binutils]objdump.exe,
282and [.binutils]strings.exe) and the gnu assembler and preprocessor
283([.gas]as.exe and [.gas]gasp.exe]) to a directory of your choice
284and define all programs as foreign commands.
285
286
287If you're satisfied with the compilation, you may want to remove
288unneeded objects and libraries:
289
290 $ gmake clean
291
292
293If you have any problems or questions about the binutils on VMS, feel
294free to mail me at kkaempf@rmi.de.
295
296Copyright (C) 2012-2022 Free Software Foundation, Inc.
297
298Copying and distribution of this file, with or without modification,
299are permitted in any medium without royalty provided the copyright
300notice and this notice are preserved.
301
README-how-to-make-a-release
1 README for MAKING BINUTILS RELEASES
2
3This is a collection of notes on how to perform a binutils release. A
4lot of this information can also be found in the maintain.texi file in
5the gnulib project:
6
7 https://www.gnu.org/software/gnulib/
8
9It is useful to have a cloned copy of the sources of this project as
10it also contains an upload script used to install tarballs on the GNU
11FTP server.
12
13Make sure that you have upload authority on sourceware and fencepost.
14Beware - this is an involved process and can take weeks to complete.
15See the maintain.texi file for details on how to obtain these
16permissions.
17
18-------------------------------------------------
19How to perform a release.
20-------------------------------------------------
21
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).
25
26 2. When the branch date is near: Update the libiberty and config
27 directories and the top level Makefile and configure files. Also
28 consider updating the toplevel libtool files.
29
30
31Approx time to complete from here: 2 hours ....
32
33 3. When branch day arrives add markers for the upcoming release to
34 the NEWS files in gas, ld, and binutils. No need to update NEWS
35 in the gold directory - it has its own release numbering.
36
37 Likewise for the ChangeLog files in: bfd, binutils, config, cpu,
38 elfcpp, gas, gold, gprof, include, ld, libctf, libiberty, opcodes
39 and toplevel.
40
41 Add a note of the name of the new branch to binutils/BRANCHES.
42
43 Commit these changes.
44
45 4. Create the release branch using:
46
47 git branch binutils-2_39-branch
48 git push origin binutils-2_39-branch
49
50 If you get a message like:
51
52 remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b
53
54 It appears that this can be ignored...
55
56 5. Make sure that the branch is there. IE check out the branch sources:
57
58 git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_39-branch 2.39
59
60 If you get a message about being in a "detached head" state, something
61 has gone wrong...
62
63 Keep the checked out sources - they are going to be needed in future
64 steps.
65
66 6. Update "BINUTILS_BRANCH" in gdbadmin's crontab:
67
68 Log in as gdbadmin on sourceware.org, and then:
69
70 $ cd crontab
71 $ vi crontab
72 [change BINUTILS_BRANCH]
73 $ cvs ci crontab
74 $ crontab crontab
75
76 If you do not have access to this account, please feel free to
77 ask Joel Brobecker <brobecker AT adacore DOT com>.
78
79 7. Rename the current HEAD version entry in Bugzilla, and create a
80 new one. E.g. rename "2.38 (HEAD)" to 2.38, and create
81 "2.39 (HEAD)":
82
83 https://sourceware.org/bugzilla/editversions.cgi?product=binutils
84
85 8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
86 of the next release. Note if the release is going to be 2.39 then
87 the version number on the branch is set to 2.38.90 - ie almost, but
88 not quite at 2.39, and the version number on the mainline is set to
89 2.39.50 - ie half way to the next release after 2.39.
90
91 So the branch bfd/version.m4 has:
92
93 m4_define([BFD_VERSION], [2.38.90])
94
95 and the mainline has:
96
97 m4_define([BFD_VERSION], [2.39.50])
98
99 Regenerate various files on both branch and HEAD by configuring
100 with "--enable-maintainer-mode --enable-gold --enable-shared" and then building
101 with "make all-binutils all-gas all-gold all-gprof all-gprofng all-ld"
102
103 Add ChangeLog entries for the updated files. Commit the changes.
104 Make sure that this includes the .pot files as well as the
105 configure and makefiles.
106
107 9. Create an initial pre-release:
108
109 a. Remove any auto-generated files, in order to force the
110 src-release script to rebuild them.
111
112 cd <branch-sources>
113 git clean -fdx
114
115 b. Create a source tarball of the BRANCH sources:
116
117 ./src-release.sh -x binutils
118
119 c. Build a test target using this tarball.
120
121 cp binutils-2.38.90.tar.xz /dev/shm
122 pushd /dev/shm
123 tar xvf binutils-2.38.90.tar.xz
124 mkdir build
125 cd build
126 ../binutils-2.38.90/configure --quiet --enable-gold
127 make
128 popd
129
130 If there are problems, fix them.
131
132 d. Upload the pre-release snapshot to the sourceware FTP site:
133
134 scp binutils-2.38.90.tar.xz sourceware.org:~ftp/pub/binutils/snapshots
135 ssh sourceware.org sha256sum ~ftp/pub/binutils/snapshots/binutils-2.38.90.tar.xz
136
137 e. Clean up the source directory again.
138
139 git clean -fdx
140
141 10. Tell the Translation Project where to find the new tarball.
142 <coordinator@translationproject.org>
143 qv: https://translationproject.org/html/maintainers.html
144
145------------------------------------------------------------------------
146Dear Translation Project
147
148 The 2.39 release branch has been created for the GNU Binutils project.
149
150 A snapshot of the branch sources can be found here:
151
152 https://sourceware.org/pub/binutils/snapshots/binutils-2.38.90.tar.xz
153
154 We hope to make the official release of the sources on the <DATE>
155 although that could change if there are important bugs that need to
156 be fixed before the release.
157------------------------------------------------------------------------
158
159 11. Announce the availability of the snapshot and the branch on the
160 binutils mailing list. Set a date for when the release will
161 actually happen. Something like:
162
163------------------------------------------------------------------------
164Hi Everyone,
165
166 The <NEW_VERSION> branch has now been created:
167
168 git clone git://sourceware.org/git/binutils-gdb.git -b binutils-<NEW_VERSION>-branch
169
170 A snapshot of the sources is also available here:
171
172 https://sourceware.org/pub/binutils/snapshots/binutils-<OLD_VERSION>.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. <DATE>. Which I hope will be enough time for everyone
186 to get their final fixes in.
187------------------------------------------------------------------------
188
189 12. Build various different toolchains, test them and nag
190 maintainers to fix any testsuite failures for their
191 architectures...
192
193==============================================================================
194
195When the time comes to actually make the release....
196
197
198 20. Make sure that the branch sources still build, test and install
199 correctly. Make sure that the sources are clean, without any
200 patch files (.reg .orig *~) left over.
201
202 cd <branch>
203 git clean -fdx
204
205 21. a. Update the release number in bfd/version.m4 on the release
206 branch to a whole new minor version number, without a point
207 value. Eg "2.38.90" becomes "2.39".
208
209 b. Change bfd/development.sh to set all values to "false".
210
211 c. Regenerate the configure and makefiles. And *info* files.
212
213 d. Create a ChangeLog from the git refs for all of the commits
214 from when changelog entries were no longer required:
215
216 gitlog-to-changelog --since=2021-07-03 > ChangeLog.git
217
218 The gitlog-to-changelog script is part of the sources
219 of the "config" project.
220
221 e. Add ChangeLog entries for all of the updates and add a
222 "this-is-the-2.38-release" comment and commit.
223
224 22. Check that your file creation mask will create the
225 correct file permissions. Eg:
226
227 % umask
228 22
229
230 Remove any spurious autom4te.cache files left over from the
231 reconfiguring:
232
233 git clean -fdx
234
235 23. Note - check to see if any new files have been added to the top
236 level of the source directory, but which are not in the
237 DEVO_SUPPORT variable in the src-release.sh script. If they are
238 needed then add them. NB/ Add the new ChangeLog.git file.
239
240 Create the release tarballs:
241
242 ./src-release.sh -b -g -l -x binutils
243
244 24. Check that the files in the tarballs have the correct
245 permissions.
246
247 tar tvf binutils-2.39.tar.bz2 | grep -e "---"
248
249 Also check that the man files are not empty. (cf PR 28144).
250
251 tar tvf binutils-2.39.tar.xz | grep -e "\.1"
252
253 25. Sanity check the release on x86_64-pc-linux-gnu by building and
254 running the testsuites (gas, gold, binutils and ld). Make the
255 source directory read-only before building. Also test
256 "make install". If necessary fix any problems.
257
258 pushd /dev/shm
259 mkdir delme
260 cd delme
261 tar xvf <path-to-sources>/binutils-2.*.tar.lz
262 chmod -R -w binutils-2.*
263 mkdir build
264 cd build
265 ../binutils-2.*/configure --quiet --enable-gold --prefix=`pwd`/install --enable-plugins --enable-shared
266 make all-gas all-gold all-ld all-binutils all-gprof all-gprofng
267 make check-gas check-binutils check-ld check-gold
268 make install-gas install-gold install-ld install-binutils
269
270 # Needed for step 29...
271 make html pdf
272
273 popd
274
275 26. Tag the branch with the new release number:
276 [optional: add "-u XXXXX" to sign with a gpg key]
277 enter a tag message such as: "Official GNU Binutils 2.3x release"
278
279 git tag -a binutils-2_38 -u DD9E3C4F <=== Be careful to get the tag right
280
281 NB/ If you do sign the binaries make sure to use a key
282 that has been published with the FSF.
283
284 Then push the release:
285
286 git push origin binutils-2_3x
287
288 If you get an error message along the lines of:
289 "Invalid revision range ..." you can ignore it.
290
291 27. Upload the tarballs to ftp.gnu.org.
292
293 gnupload --to ftp.gnu.org:binutils binutils-2.3*.tar.*
294
295 Be prepared to provide the password for the key, if you
296 signed the binaries.
297
298 The gnupload script is in the gnulib/build-aux directory.
299
300 Check for an email response from the upload. If necessary
301 fix any problems.
302
303 28. Upload the tarballs (and signatures) to sourceware.org:
304
305 sftp sourceware.org
306 cd /sourceware/ftp/pub/binutils/releases
307 put binutils-2.3*.tar.*
308 chmod 644 binutils-2.3x.tar.*
309 quit
310
311 FIXME: Are the signatures (created by the gnupload script in step 27)
312 needed ? [The above commands upload them and nobody has complained,
313 so suggest that they are retained].
314
315 29. Update web pages. For sourceware.org:
316
317 Create a new documentation folder on the sourceware.org web
318 pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x.
319
320 sftp sourceware.org
321 cd /sourceware/www/sourceware/htdocs/binutils
322 mkdir docs-2.3x
323 cd docs-2.3x
324 mkdir as
325 mkdir bfd
326 mkdir binutils
327 mkdir gprof
328 mkdir ld
329 cd ../docs-2.3(x-1)
330 get index.html
331
332 Update the (local copy of the) index.html file to point to the
333 new documentation and mention the new version and then upload it.
334
335 cd ../docs-2.3x
336 put index.html
337
338 Make the html documentation locally with the "make html" command
339 (see step 25 above). Then upload and rename the directories as
340 needed. (sftp does not appear to support recursive uploads
341 however, so the directories had to be made by hand, as shown above).
342
343 cd as
344 lcd <build-dir>/gas/doc/as
345 put * {be patient - this takes a long time...}
346 lcd ..
347 cd ..
348 put as.html
349 put as.pdf
350 cd bfd
351 lcd ../../bfd/doc/bfd
352 put *
353 cd ..
354 lcd ..
355 put bfd.html
356 put bfd.pdf
357 cd binutils
358 lcd ../../binutils/binutils <=== NB/ Path not like others
359 put *
360 cd ..
361 lcd ../doc
362 put binutils.html
363 put binutils.pdf
364 cd gprof
365 lcd ../../gprof/doc/gprof
366 put *
367 cd ..
368 lcd ../..
369 put gprof.html
370 put gprof.pdf
371 cd ld
372 lcd ../ld/doc/ld
373 put *
374 cd ..
375 lcd ../..
376 put ld.html
377 put ld.pdf
378
379 Edit the top level binutils index.html file to change the links
380 to point to the new documentation.
381
382 cd ../..
383 get index.html
384 [edit]
385 put index.html
386 rm docs
387 ln -s docs-2.3x docs
388 quit
389
390 Check that the new web page is correct:
391
392 https://sourceware.org/binutils/
393
394 For the www.gnu.org site you have to email webmasters@gnu.org
395 and ask them to make the change(s):
396---------------------------------------
397Hi FSF Webmasters,
398
399 Please could the GNU Binutils webpage at:
400
401https://www.gnu.org/software/binutils/binutils.html
402
403 be updated to indicate that there is now a newer version available
404 (2.3x). I have already updated the related page on the sourceware
405 website so this might be useful as a template:
406
407https://sourceware.org/binutils/
408
409 Thanks very much.
410
411Cheers
412--------------------------------------
413
414 30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and
415 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
416 Sign the email and include the checksum:
417
418 sha256sum binutils-2.3*.tar.*
419
420 (The email to Davis is so that he can update the GNU Toolchain
421 social media). Something like this:
422 -----------------------------------------------------------------------
423 Hi Everyone,
424
425 We are pleased to announce that version 2.3x of the GNU Binutils project
426 sources have been released and are now available for download at:
427
428 https://ftp.gnu.org/gnu/binutils
429 https://sourceware.org/pub/binutils/releases/
430
431 checksums: xxxx
432
433 This release contains numerous bug fixes, and also the
434 following new features:
435
436 <extract info from the NEWS files>
437
438 Our thanks go out to all of the binutils contributors, past and
439 present, for helping to make this release possible.
440
441 -----------------------------------------------------------------------
442
443 31. Clean up the source tree:
444
445 git clean -fdx .
446
447 32. Edit bfd/development.sh on the branch and set the development flag
448 to "true". (Leave the experimental flag set to "false"). Also bump
449 the version in bfd/version.m4 by adding a trailing .0, so that the
450 date suffix keeps the version lower than the trunk version.
451 Regenerate files. Commit these changes.
452
453 33. Email the binutils list telling everyone that the 2.3x branch
454 is now open for business as usual and that patches no longer
455 need special approval.
456
457 34. Examine the bfd/config.bfd file in the mainline sources and move
458 any pending obsolete targets into the definitely obsolete
459 section. Create a changelog entry and commit.
460
461
462
463
464--------------------------------------------------------------------------
465How to perform a POINT release.
466--------------------------------------------------------------------------
467
468A point release is easier than a normal release since a lot of the
469work has already been done. The branch has been created, the
470translations updated and the documentation uploaded. So the procedure
471looks like this:
472
473 0. Decide that a point release is necessary.
474
475 Usually this only happens when a sufficient number of serious
476 bugs have been found and fixed since the previous release, and a
477 new official release is not imminent.
478
479 1. Tell the community that a point release is happening. Ask
480 maintainers to ensure that their ports are up to date on the
481 release branch. Ask the community if there are any bug fixes
482 which are missing from the branch. Allow some time for the
483 responses to this step.
484
485 2. Make sure that the branch sources build, test and install
486 correctly.
487
488 2.5 Prepare a list of the bugs which have been fixed. This
489 will be needed for step 8.
490
491 3. In the branch sources:
492
493 a. Update the minor release number in bfd/version.m4.
494 b. Edit bfd/development.sh, set "development=false".
495 c. Regenerate the configure files.
496 d. Remove spurious autom4te.cache files:
497
498 git clean -fdx
499
500 e. Commit the updates along with a "this-is-the-2.3x.y-release"
501 note in all of the changelogs.
502 f. Tag the branch with the new release number:
503
504 git tag -a binutils-2_3x_y
505 [optional: add "-u XXXXX" to sign with a gpg key]
506 git push origin binutils-2_3x_y
507
508 g. Check that your file creation mask will create the
509 correct file permissions. Ie:
510
511 umask 022
512
513 h. Create the release tarballs:
514
515 ./src-release -b -g -l -x binutils
516
517 i. Check that the files in the tarballs have the correct
518 permissions.
519
520 j. Clean the source tree again
521
522 git clean -fdx
523
524 k. Edit bfd/development.sh and set "development=true".
525 l. Commit this change.
526
527 4. [If paranoid - upload the tarballs to one of the FTP servers and
528 ask people to test it before going on to step 5].
529
530 5. Upload the tarballs to ftp.gnu.org.
531
532 gnupload --to ftp.gnu.org:binutils binutils-*.tar.*
533
534 The gnupload script is in the gnulib/build-aux directory.
535
536 6. Upload the tarballs to sourceware.org:
537
538 sftp sourceware.org
539 cd /sourceware/ftp/pub/binutils/releases
540 put binutils-*.tar.*
541 chmod 644 binutils-*.tar.*
542 quit
543
544 It is OK to upload the signatures as well.
545
546 7. Update web pages. For sourceware.org:
547
548 * Log on to sourceware.org
549 * Go to /sourceware/www/sourceware/htdocs/binutils
550 * Edit index.html and update the latest release number (if this is a latest release)
551
552 For the www.gnu.org site you have to email webmasters@gnu.org
553 and ask them to make the change(s).
554
555 8. Send an emails to the binutils list, info-gnu@gnu.org and
556 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
557 (The email to Davis is so that he can update the GNU Toolchain
558 social media). Something like this:
559
560------------------------------------------------------------------------
561Hi Everyone,
562
563 We are pleased to announce that version 2.3x.y of the GNU Binutils
564 project sources have been released and are now available for download at:
565
566 https://ftp.gnu.org/gnu/binutils
567 https://sourceware.org/pub/binutils/releases/
568
569 This is a point release over the previous 2.3x version, containing bug
570 fixes but no new features.
571
572 Our thanks go out to all of the binutils contributors, past and
573 present, for helping to make this release possible.
574
575 Here is a list of the bugs that have been fixed:
576 xx
577 xx
578 xx
579 xx
580--------------------------------------------------------------------------
581
582 9. Create a new Bugzilla entry for the point release.
583
584 https://sourceware.org/bugzilla/editversions.cgi?product=binutils
585
586 And a new milestone too:
587
588 https://sourceware.org/bugzilla/editmilestones.cgi?product=binutils
589
590Copyright (C) 2017-2022 Free Software Foundation, Inc.
591
592Copying and distribution of this file, with or without modification,
593are permitted in any medium without royalty provided the copyright
594notice and this notice are preserved.
595