This is the mail archive of the
binutils@sources.redhat.com
mailing list for the binutils project.
[PATCH] fix indentation and long lines in bfd docs
- From: Bob Wilson <bwilson at tensilica dot com>
- To: binutils at sources dot redhat dot com
- Date: Wed, 12 Feb 2003 17:37:58 -0800
- Subject: [PATCH] fix indentation and long lines in bfd docs
- Organization: Tensilica, Inc.
This patch fixes up some inconsistent indentation and splits up long lines
that generate overfull hboxes in TeX with some formats (e.g., smallbook). It
also changes the documentation for functions described as "stuff" to "Other
Functions" so that it isn't quite so obviously unfinished.
2003-02-12 Bob Wilson <bob.wilson@acm.org>
* bfd.c: Change embedded documentation to use consistent indentation
and to split up long lines. Change informal style of description
for functions lacking real documentation.
* coffcode.h: Break up long lines in embedded documentation.
* format.c: Likewise.
* libcoff.h: Likewise.
* targets.c: Likewise.
* bfd-in2.h: Regenerate.
Index: bfd.c
===================================================================
RCS file: /cvs/src/src/bfd/bfd.c,v
retrieving revision 1.45
diff -c -3 -r1.45 bfd.c
*** bfd.c 27 Jan 2003 23:40:39 -0000 1.45
--- bfd.c 12 Feb 2003 22:21:17 -0000
***************
*** 1076,1111 ****
/*
FUNCTION
! stuff
DESCRIPTION
! Stuff which should be documented:
.#define bfd_sizeof_headers(abfd, reloc) \
! . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
.
.#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
! . BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
.
- . {* Do these three do anything useful at all, for any back end? *}
.#define bfd_debug_info_start(abfd) \
! . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
.
.#define bfd_debug_info_end(abfd) \
! . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
.
.#define bfd_debug_info_accumulate(abfd, section) \
! . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
! .
.
.#define bfd_stat_arch_elt(abfd, stat) \
! . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
.
.#define bfd_update_armap_timestamp(abfd) \
! . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
.
.#define bfd_set_arch_mach(abfd, arch, mach)\
! . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
.
.#define bfd_relax_section(abfd, section, link_info, again) \
. BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
--- 1076,1110 ----
/*
FUNCTION
! Other functions
DESCRIPTION
! The following functions exist but have not yet been documented.
.#define bfd_sizeof_headers(abfd, reloc) \
! . BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
.
.#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
! . BFD_SEND (abfd, _bfd_find_nearest_line, \
! . (abfd, sec, syms, off, file, func, line))
.
.#define bfd_debug_info_start(abfd) \
! . BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
.
.#define bfd_debug_info_end(abfd) \
! . BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
.
.#define bfd_debug_info_accumulate(abfd, section) \
! . BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
.
.#define bfd_stat_arch_elt(abfd, stat) \
! . BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
.
.#define bfd_update_armap_timestamp(abfd) \
! . BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
.
.#define bfd_set_arch_mach(abfd, arch, mach)\
! . BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
.
.#define bfd_relax_section(abfd, section, link_info, again) \
. BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
Index: coffcode.h
===================================================================
RCS file: /cvs/src/src/bfd/coffcode.h,v
retrieving revision 1.86
diff -c -3 -r1.86 coffcode.h
*** coffcode.h 20 Jan 2003 22:34:38 -0000 1.86
--- coffcode.h 12 Feb 2003 22:21:17 -0000
***************
*** 1344,1350 ****
.#define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
. ((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
.#define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
! . ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook) (abfd, filehdr, aouthdr))
.
.#define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name, section, flags_ptr)\
. ((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook)\
--- 1344,1351 ----
.#define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
. ((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
.#define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
! . ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook)\
! . (abfd, filehdr, aouthdr))
.
.#define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name, section, flags_ptr)\
. ((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook)\
***************
*** 1369,1375 ****
. ((coff_backend_info (abfd)->_bfd_coff_print_aux)\
. (abfd, file, base, symbol, aux, indaux))
.
! .#define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr)\
. ((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
. (abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
.
--- 1370,1377 ----
. ((coff_backend_info (abfd)->_bfd_coff_print_aux)\
. (abfd, file, base, symbol, aux, indaux))
.
! .#define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order,\
! . reloc, data, src_ptr, dst_ptr)\
. ((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
. (abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
.
***************
*** 1397,1403 ****
.#define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
. ((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
. (obfd, info, ibfd, sec, rel, adjustedp))
! .#define bfd_coff_link_add_one_symbol(info,abfd,name,flags,section,value,string,cp,coll,hashp)\
. ((coff_backend_info (abfd)->_bfd_coff_link_add_one_symbol)\
. (info, abfd, name, flags, section, value, string, cp, coll, hashp))
.
--- 1399,1406 ----
.#define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
. ((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
. (obfd, info, ibfd, sec, rel, adjustedp))
! .#define bfd_coff_link_add_one_symbol(info, abfd, name, flags, section,\
! . value, string, cp, coll, hashp)\
. ((coff_backend_info (abfd)->_bfd_coff_link_add_one_symbol)\
. (info, abfd, name, flags, section, value, string, cp, coll, hashp))
.
Index: format.c
===================================================================
RCS file: /cvs/src/src/bfd/format.c,v
retrieving revision 1.11
diff -c -3 -r1.11 format.c
*** format.c 30 Nov 2002 08:39:39 -0000 1.11
--- format.c 12 Feb 2003 22:21:17 -0000
***************
*** 98,104 ****
bfd_check_format_matches
SYNOPSIS
! bfd_boolean bfd_check_format_matches(bfd *abfd, bfd_format format, char ***matching);
DESCRIPTION
Like <<bfd_check_format>>, except when it returns FALSE with
--- 98,105 ----
bfd_check_format_matches
SYNOPSIS
! bfd_boolean bfd_check_format_matches(bfd *abfd, bfd_format format,
! char ***matching);
DESCRIPTION
Like <<bfd_check_format>>, except when it returns FALSE with
Index: libcoff.h
===================================================================
RCS file: /cvs/src/src/bfd/libcoff.h,v
retrieving revision 1.29
diff -c -3 -r1.29 libcoff.h
*** libcoff.h 30 Nov 2002 08:39:39 -0000 1.29
--- libcoff.h 12 Feb 2003 22:21:18 -0000
***************
*** 866,872 ****
#define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
#define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
! ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook) (abfd, filehdr, aouthdr))
#define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name, section, flags_ptr)\
((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook)\
--- 866,873 ----
#define bfd_coff_set_arch_mach_hook(abfd, filehdr)\
((coff_backend_info (abfd)->_bfd_coff_set_arch_mach_hook) (abfd, filehdr))
#define bfd_coff_mkobject_hook(abfd, filehdr, aouthdr)\
! ((coff_backend_info (abfd)->_bfd_coff_mkobject_hook)\
! (abfd, filehdr, aouthdr))
#define bfd_coff_styp_to_sec_flags_hook(abfd, scnhdr, name, section, flags_ptr)\
((coff_backend_info (abfd)->_bfd_styp_to_sec_flags_hook)\
***************
*** 891,897 ****
((coff_backend_info (abfd)->_bfd_coff_print_aux)\
(abfd, file, base, symbol, aux, indaux))
! #define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr)\
((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
(abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
--- 892,899 ----
((coff_backend_info (abfd)->_bfd_coff_print_aux)\
(abfd, file, base, symbol, aux, indaux))
! #define bfd_coff_reloc16_extra_cases(abfd, link_info, link_order,\
! reloc, data, src_ptr, dst_ptr)\
((coff_backend_info (abfd)->_bfd_coff_reloc16_extra_cases)\
(abfd, link_info, link_order, reloc, data, src_ptr, dst_ptr))
***************
*** 919,925 ****
#define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
(obfd, info, ibfd, sec, rel, adjustedp))
! #define bfd_coff_link_add_one_symbol(info,abfd,name,flags,section,value,string,cp,coll,hashp)\
((coff_backend_info (abfd)->_bfd_coff_link_add_one_symbol)\
(info, abfd, name, flags, section, value, string, cp, coll, hashp))
--- 921,928 ----
#define bfd_coff_adjust_symndx(obfd, info, ibfd, sec, rel, adjustedp)\
((coff_backend_info (abfd)->_bfd_coff_adjust_symndx)\
(obfd, info, ibfd, sec, rel, adjustedp))
! #define bfd_coff_link_add_one_symbol(info, abfd, name, flags, section,\
! value, string, cp, coll, hashp)\
((coff_backend_info (abfd)->_bfd_coff_link_add_one_symbol)\
(info, abfd, name, flags, section, value, string, cp, coll, hashp))
Index: targets.c
===================================================================
RCS file: /cvs/src/src/bfd/targets.c,v
retrieving revision 1.90
diff -c -3 -r1.90 targets.c
*** targets.c 3 Jan 2003 21:12:28 -0000 1.90
--- targets.c 12 Feb 2003 22:21:18 -0000
***************
*** 1319,1325 ****
bfd_seach_for_target
SYNOPSIS
! const bfd_target * bfd_search_for_target (int (* search_func) (const bfd_target *, void *), void *);
DESCRIPTION
Return a pointer to the first transfer vector in the list of
--- 1323,1331 ----
bfd_seach_for_target
SYNOPSIS
! const bfd_target * bfd_search_for_target (int (* search_func)
! (const bfd_target *, void *),
! void *);
DESCRIPTION
Return a pointer to the first transfer vector in the list of
Index: bfd-in2.h
===================================================================
RCS file: /cvs/src/src/bfd/bfd-in2.h,v
retrieving revision 1.199
diff -c -3 -r1.199 bfd-in2.h
*** bfd-in2.h 10 Feb 2003 10:44:46 -0000 1.199
--- bfd-in2.h 12 Feb 2003 22:21:17 -0000
***************
*** 3875,3904 ****
BFD_SEND (abfd, _bfd_set_private_flags, \
(abfd, flags))
#define bfd_sizeof_headers(abfd, reloc) \
! BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
! BFD_SEND (abfd, _bfd_find_nearest_line, (abfd, sec, syms, off, file, func, line))
- /* Do these three do anything useful at all, for any back end? */
#define bfd_debug_info_start(abfd) \
! BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
#define bfd_debug_info_end(abfd) \
! BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
#define bfd_debug_info_accumulate(abfd, section) \
! BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
!
#define bfd_stat_arch_elt(abfd, stat) \
! BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
#define bfd_update_armap_timestamp(abfd) \
! BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
#define bfd_set_arch_mach(abfd, arch, mach)\
! BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
#define bfd_relax_section(abfd, section, link_info, again) \
BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
--- 3923,3951 ----
BFD_SEND (abfd, _bfd_set_private_flags, \
(abfd, flags))
#define bfd_sizeof_headers(abfd, reloc) \
! BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
! BFD_SEND (abfd, _bfd_find_nearest_line, \
! (abfd, sec, syms, off, file, func, line))
#define bfd_debug_info_start(abfd) \
! BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
#define bfd_debug_info_end(abfd) \
! BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
#define bfd_debug_info_accumulate(abfd, section) \
! BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
#define bfd_stat_arch_elt(abfd, stat) \
! BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
#define bfd_update_armap_timestamp(abfd) \
! BFD_SEND (abfd, _bfd_update_armap_timestamp, (abfd))
#define bfd_set_arch_mach(abfd, arch, mach)\
! BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
#define bfd_relax_section(abfd, section, link_info, again) \
BFD_SEND (abfd, _bfd_relax_section, (abfd, section, link_info, again))
***************
*** 4357,4370 ****
bfd_target_list PARAMS ((void));
const bfd_target *
! bfd_search_for_target PARAMS ((int (* search_func) (const bfd_target *, void *), void *));
/* Extracted from format.c. */
bfd_boolean
bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
bfd_boolean
! bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format, char ***matching));
bfd_boolean
bfd_set_format PARAMS ((bfd *abfd, bfd_format format));
--- 4404,4420 ----
bfd_target_list PARAMS ((void));
const bfd_target *
! bfd_search_for_target PARAMS ((int (* search_func)
! (const bfd_target *, void *),
! void *));
/* Extracted from format.c. */
bfd_boolean
bfd_check_format PARAMS ((bfd *abfd, bfd_format format));
bfd_boolean
! bfd_check_format_matches PARAMS ((bfd *abfd, bfd_format format,
! char ***matching));
bfd_boolean
bfd_set_format PARAMS ((bfd *abfd, bfd_format format));