Name Date Size #Lines LOC

..--

doc/H--15,51313,758

po/H--251,346205,018

BRANCHESH A D29-Jun-20241.8 KiB6556

ChangeLogH A D29-Jun-202459.7 KiB1,8661,365

ChangeLog-0001H A D14-Apr-201863.1 KiB2,0671,457

ChangeLog-0203H A D14-Apr-201866.8 KiB2,1881,542

ChangeLog-2004H A D14-Apr-201825.6 KiB800572

ChangeLog-2005H A D14-Apr-201843 KiB1,357984

ChangeLog-2006H A D14-Apr-201818.5 KiB606425

ChangeLog-2007H A D14-Apr-201836.7 KiB1,172841

ChangeLog-2008H A D14-Apr-201828.2 KiB881631

ChangeLog-2009H A D14-Apr-201843.6 KiB1,362999

ChangeLog-2010H A D14-Apr-201832.2 KiB1,084771

ChangeLog-2011H A D29-Jun-202430.4 KiB937699

ChangeLog-2012H A D14-Apr-201823 KiB757549

ChangeLog-2013H A D14-Apr-201821.1 KiB682486

ChangeLog-2014H A D14-Apr-201831.2 KiB961701

ChangeLog-2015H A D14-Apr-201832.1 KiB1,035748

ChangeLog-2016H A D03-Apr-202032 KiB989715

ChangeLog-2017H A D29-Jun-202462.9 KiB1,8871,418

ChangeLog-2018H A D23-Dec-202251.1 KiB1,5591,138

ChangeLog-2019H A D23-Dec-202250 KiB1,5261,134

ChangeLog-2020H A D29-Jun-202468.4 KiB2,0811,532

ChangeLog-9197H A D14-Apr-2018188 KiB5,2243,780

ChangeLog-9899H A D14-Apr-201863.8 KiB1,9151,382

MAINTAINERSH A D29-Jun-202412.4 KiB318253

Makefile.amH A D29-Jun-202420.3 KiB571407

Makefile.inH A D29-Jun-202484 KiB2,1531,761

NEWSH A D29-Jun-202434.1 KiB862588

READMEH A D29-Jun-202411.2 KiB301219

README-how-to-make-a-releaseH A D29-Jun-202418.8 KiB595411

aclocal.m4H A D29-Jun-202443.6 KiB1,2131,104

addr2line.cH A D29-Jun-202414.9 KiB581434

ar.cH A D29-Jun-202442.3 KiB1,6411,178

arlex.cH A D29-Jun-202452.4 KiB2,0431,335

arlex.lH A D29-Jun-20242.3 KiB9158

arparse.cH A D29-Jun-202449.9 KiB1,5981,052

arparse.hH A D29-Jun-20243.8 KiB12874

arparse.yH A D29-Jun-20243.1 KiB203142

arsup.cH A D29-Jun-202410 KiB515406

arsup.hH A D29-Jun-20241.5 KiB6322

bfdtest1.cH A D29-Jun-20241.7 KiB7141

bfdtest2.cH A D29-Jun-20242.5 KiB10766

bin2c.cH A D29-Jun-20241.6 KiB6739

binemul.cH A D29-Jun-20243.9 KiB170116

binemul.hH A D29-Jun-20242.4 KiB6734

bucomm.cH A D29-Jun-202416.9 KiB718520

bucomm.hH A D29-Jun-20242.5 KiB9437

budbg.hH A D29-Jun-20241.7 KiB5214

coffdump.cH A D29-Jun-202410.9 KiB557476

coffgrok.cH A D29-Jun-202422.5 KiB906745

coffgrok.hH A D29-Jun-20244.8 KiB222175

config.inH A D29-Jun-20247.1 KiB266188

configureH A D29-Jun-2024497.9 KiB17,37414,670

configure.acH A D29-Jun-202415.5 KiB559488

configure.comH A D29-Jun-20244.6 KiB147139

configure.tgtH A D29-Jun-20241.4 KiB4337

cxxfilt.cH A D29-Jun-20246.9 KiB261197

debug.cH A D29-Jun-202485.1 KiB3,3842,353

debug.hH A D29-Jun-202428.6 KiB790211

deflex.cH A D29-Jun-202453.3 KiB2,0701,361

deflex.lH A D29-Jun-20242.4 KiB9261

defparse.cH A D29-Jun-202465.6 KiB2,0171,427

defparse.hH A D29-Jun-20244.6 KiB15097

defparse.yH A D29-Jun-20245.6 KiB245192

demanguse.cH A D29-Jun-20241.7 KiB5528

demanguse.hH A D29-Jun-20241 KiB3510

dep-in.sedH A D14-Apr-2018257 2118

dlltool.cH A D29-Jun-2024113 KiB4,3103,142

dlltool.hH A D29-Jun-20241.5 KiB4018

dllwrap.cH A D29-Jun-202433.7 KiB1,256968

dwarf-mode.elH A D29-Jun-20248 KiB232155

dwarf.cH A D29-Jun-2024339.5 KiB12,36610,076

dwarf.hH A D29-Jun-20249.2 KiB338256

elfcomm.cH A D29-Jun-202422.5 KiB816609

elfcomm.hH A D29-Jun-20244.2 KiB10247

elfedit.cH A D29-Jun-202428.1 KiB1,106895

embedspu.shH A D29-Jun-20248.4 KiB261202

emul_aix.cH A D29-Jun-20243.2 KiB13189

emul_vanilla.cH A D29-Jun-20241.1 KiB318

filemode.cH A D29-Jun-20246 KiB249157

is-ranlib.cH A D29-Jun-2024915 231

is-strip.cH A D29-Jun-2024926 241

makefile.vmsH A D29-Jun-20242.5 KiB9146

maybe-ranlib.cH A D29-Jun-2024959 241

maybe-strip.cH A D29-Jun-2024967 241

mclex.cH A D29-Jun-202410.6 KiB463396

mcparse.cH A D29-Jun-202464.2 KiB2,0151,427

mcparse.hH A D29-Jun-20244 KiB12976

mcparse.yH A D29-Jun-20248.4 KiB357293

nm.cH A D29-Jun-202455.9 KiB2,2061,726

not-ranlib.cH A D29-Jun-2024915 231

not-strip.cH A D29-Jun-2024926 241

objcopy.cH A D29-Jun-2024167.8 KiB6,0644,664

objdump.cH A D29-Jun-2024153.2 KiB5,9344,555

objdump.hH A D29-Jun-20241.7 KiB5415

od-elf32_avr.cH A D29-Jun-20249.9 KiB365275

od-macho.cH A D29-Jun-202468.9 KiB2,3062,043

od-xcoff.cH A D29-Jun-202451 KiB1,8441,545

prdbg.cH A D29-Jun-202459.8 KiB2,8012,092

ranlib.shH A D29-Jun-2024902 231

rclex.cH A D29-Jun-202418 KiB905723

rcparse.cH A D29-Jun-2024157.2 KiB4,7973,979

rcparse.hH A D29-Jun-202410.2 KiB326272

rcparse.yH A D29-Jun-202440.3 KiB2,0221,761

rdcoff.cH A D29-Jun-202420.9 KiB885664

rddbg.cH A D29-Jun-202410.3 KiB438314

readelf.cH A D29-Jun-2024610.6 KiB22,86619,202

rename.cH A D29-Jun-20245.9 KiB229162

resbin.cH A D29-Jun-202455.3 KiB2,1661,675

rescoff.cH A D29-Jun-202421.6 KiB768492

resrc.cH A D29-Jun-202482.6 KiB3,3972,622

resres.cH A D29-Jun-202419.7 KiB731545

sanity.shH A D29-Jun-20241.6 KiB6825

size.cH A D29-Jun-202415.6 KiB663512

srconv.cH A D29-Jun-202438.7 KiB1,8531,469

stabs.cH A D29-Jun-2024133.9 KiB5,5594,115

strings.cH A D29-Jun-202431.9 KiB1,346960

sysdep.hH A D29-Jun-20243.3 KiB14095

sysdump.cH A D29-Jun-202412 KiB721565

sysinfo.cH A D29-Jun-202451.7 KiB1,7871,241

sysinfo.hH A D29-Jun-20243 KiB10350

sysinfo.yH A D29-Jun-20248.2 KiB442357

syslex.cH A D29-Jun-202448.1 KiB1,9081,214

syslex.lH A D29-Jun-20241.9 KiB7545

syslex_wrap.cH A D29-Jun-2024933 264

sysroff.infoH A D14-Apr-201814.9 KiB505431

unwind-ia64.cH A D29-Jun-202428 KiB1,165952

unwind-ia64.hH A D29-Jun-20241.3 KiB339

version.cH A D29-Jun-20241.5 KiB4114

windint.hH A D29-Jun-202426.3 KiB1,098769

windmc.cH A D29-Jun-202429.8 KiB1,169964

windmc.hH A D29-Jun-20242.6 KiB10055

windres.cH A D29-Jun-202432.1 KiB1,4161,074

windres.hH A D29-Jun-20245.7 KiB12375

winduni.cH A D29-Jun-202423.2 KiB908708

winduni.hH A D29-Jun-20244.4 KiB14059

wrstabs.cH A D29-Jun-202454.3 KiB2,2871,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