[deliverable/binutils-gdb.git] / bfd / README

BFD is an object file library.  It permits applications to use the
same routines to process object files regardless of their format.

BFD is used by the GNU debugger, assembler, linker, and the binary
utilities.

The documentation on using BFD is scanty and may be occasionally
incorrect.  Pointers to documentation problems, or an entirely
rewritten manual, would be appreciated.

There is some BFD internals documentation in doc/bfdint.texi which may
help programmers who want to modify BFD.

BFD is normally built as part of another package.  See the build
instructions for that package, probably in a README file in the
appropriate directory.

BFD supports the following configure options:

  --target=TARGET
	The default target for which to build the library.  TARGET is
	a configuration target triplet, such as sparc-sun-solaris.
  --enable-targets=TARGET,TARGET,TARGET...
	Additional targets the library should support.  To include
	support for all known targets, use --enable-targets=all.
  --enable-64-bit-bfd
	Include support for 64 bit targets.  This is automatically
	turned on if you explicitly request a 64 bit target, but not
	for --enable-targets=all.  This requires a compiler with a 64
	bit integer type, such as gcc.
  --enable-shared
	Build BFD as a shared library.
  --with-mmap
	Use mmap when accessing files.  This is faster on some hosts,
	but slower on others.  It may not work on all hosts.

Report bugs with BFD to bug-binutils@gnu.org.

Patches are encouraged.  When sending patches, always send the output
of diff -u or diff -c from the original file to the new file.  Do not
send default diff output.  Do not make the diff from the new file to
the original file.  Remember that any patch must not break other
systems.  Remember that BFD must support cross compilation from any
host to any target, so patches which use ``#ifdef HOST'' are not
acceptable.  Please also read the ``Reporting Bugs'' section of the
gcc manual.

Bug reports without patches will be remembered, but they may never get
fixed until somebody volunteers to fix them.
\f
Copyright (C) 2012-2020 Free Software Foundation, Inc.

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
Commit	Line	Data
5b74f489	1	BFD is an object file library. It permits applications to use the
252b5132 RH	2	same routines to process object files regardless of their format.
	3
	4	BFD is used by the GNU debugger, assembler, linker, and the binary
	5	utilities.
	6
	7	The documentation on using BFD is scanty and may be occasionally
	8	incorrect. Pointers to documentation problems, or an entirely
	9	rewritten manual, would be appreciated.
	10
	11	There is some BFD internals documentation in doc/bfdint.texi which may
	12	help programmers who want to modify BFD.
	13
	14	BFD is normally built as part of another package. See the build
	15	instructions for that package, probably in a README file in the
	16	appropriate directory.
	17
	18	BFD supports the following configure options:
	19
	20	--target=TARGET
	21	The default target for which to build the library. TARGET is
	22	a configuration target triplet, such as sparc-sun-solaris.
	23	--enable-targets=TARGET,TARGET,TARGET...
	24	Additional targets the library should support. To include
	25	support for all known targets, use --enable-targets=all.
	26	--enable-64-bit-bfd
	27	Include support for 64 bit targets. This is automatically
	28	turned on if you explicitly request a 64 bit target, but not
	29	for --enable-targets=all. This requires a compiler with a 64
	30	bit integer type, such as gcc.
	31	--enable-shared
	32	Build BFD as a shared library.
	33	--with-mmap
	34	Use mmap when accessing files. This is faster on some hosts,
	35	but slower on others. It may not work on all hosts.
	36
5ad083e3	37	Report bugs with BFD to bug-binutils@gnu.org.
252b5132 RH	38
	39	Patches are encouraged. When sending patches, always send the output
	40	of diff -u or diff -c from the original file to the new file. Do not
	41	send default diff output. Do not make the diff from the new file to
	42	the original file. Remember that any patch must not break other
	43	systems. Remember that BFD must support cross compilation from any
	44	host to any target, so patches which use ``#ifdef HOST'' are not
	45	acceptable. Please also read the ``Reporting Bugs'' section of the
	46	gcc manual.
	47
	48	Bug reports without patches will be remembered, but they may never get
	49	fixed until somebody volunteers to fix them.
5bf135a7	50	\f
b3adc24a	51	Copyright (C) 2012-2020 Free Software Foundation, Inc.
5bf135a7 NC	52
	53	Copying and distribution of this file, with or without modification,
	54	are permitted in any medium without royalty provided the copyright
	55	notice and this notice are preserved.