From b5f79c764c4d8fa336c92946eec8e2d8f4e9bffd Mon Sep 17 00:00:00 2001 From: Nick Clifton Date: Wed, 30 Jan 2002 18:12:17 +0000 Subject: Tidy up formatting in bfd-in2.h --- bfd/targets.c | 114 +++++++++++++++++++++++++--------------------------------- 1 file changed, 49 insertions(+), 65 deletions(-) (limited to 'bfd/targets.c') diff --git a/bfd/targets.c b/bfd/targets.c index 352571a6b0..12bda78ff4 100644 --- a/bfd/targets.c +++ b/bfd/targets.c @@ -125,7 +125,7 @@ DESCRIPTION . (((bfd)->xvec->message[(int) ((bfd)->format)]) arglist) : \ . (bfd_assert (__FILE__,__LINE__), NULL)) .#endif - +. This is the structure which defines the type of BFD this is. The <> member of the struct <> itself points here. Each module that implements access to a different target under BFD, @@ -135,7 +135,8 @@ DESCRIPTION the entry points which call them. Too bad we can't have one macro to define them both! -.enum bfd_flavour { +.enum bfd_flavour +.{ . bfd_target_unknown_flavour, . bfd_target_aout_flavour, . bfd_target_coff_flavour, @@ -164,51 +165,40 @@ DESCRIPTION . .typedef struct bfd_target .{ - -Identifies the kind of target, e.g., SunOS4, Ultrix, etc. - +. {* Identifies the kind of target, e.g., SunOS4, Ultrix, etc. *} . char *name; - -The "flavour" of a back end is a general indication about the contents -of a file. - +. +. {* The "flavour" of a back end is a general indication about +. the contents of a file. *} . enum bfd_flavour flavour; - -The order of bytes within the data area of a file. - +. +. {* The order of bytes within the data area of a file. *} . enum bfd_endian byteorder; - -The order of bytes within the header parts of a file. - +. +. {* The order of bytes within the header parts of a file. *} . enum bfd_endian header_byteorder; - -A mask of all the flags which an executable may have set - -from the set <>, <>, ...<>. - +. +. {* A mask of all the flags which an executable may have set - +. from the set <>, <>, ...<>. *} . flagword object_flags; - -A mask of all the flags which a section may have set - from -the set <>, <>, ...<>. - +. +. {* A mask of all the flags which a section may have set - from +. the set <>, <>, ...<>. *} . flagword section_flags; - -The character normally found at the front of a symbol -(if any), perhaps `_'. - +. +. {* The character normally found at the front of a symbol. +. (if any), perhaps `_'. *} . char symbol_leading_char; - -The pad character for file names within an archive header. - +. +. {* The pad character for file names within an archive header. *} . char ar_pad_char; - -The maximum number of characters in an archive header. - +. +. {* The maximum number of characters in an archive header. *} . unsigned short ar_max_namelen; - -Entries for byte swapping for data. These are different from the other -entry points, since they don't take a BFD asthe first argument. -Certain other handlers could do the same. - +. +. {* Entries for byte swapping for data. These are different from the +. other entry points, since they don't take a BFD asthe first argument. +. Certain other handlers could do the same. *} . bfd_vma (*bfd_getx64) PARAMS ((const bfd_byte *)); . bfd_signed_vma (*bfd_getx_signed_64) PARAMS ((const bfd_byte *)); . void (*bfd_putx64) PARAMS ((bfd_vma, bfd_byte *)); @@ -218,9 +208,8 @@ Certain other handlers could do the same. . bfd_vma (*bfd_getx16) PARAMS ((const bfd_byte *)); . bfd_signed_vma (*bfd_getx_signed_16) PARAMS ((const bfd_byte *)); . void (*bfd_putx16) PARAMS ((bfd_vma, bfd_byte *)); - -Byte swapping for the headers - +. +. {* Byte swapping for the headers. *} . bfd_vma (*bfd_h_getx64) PARAMS ((const bfd_byte *)); . bfd_signed_vma (*bfd_h_getx_signed_64) PARAMS ((const bfd_byte *)); . void (*bfd_h_putx64) PARAMS ((bfd_vma, bfd_byte *)); @@ -230,25 +219,21 @@ Byte swapping for the headers . bfd_vma (*bfd_h_getx16) PARAMS ((const bfd_byte *)); . bfd_signed_vma (*bfd_h_getx_signed_16) PARAMS ((const bfd_byte *)); . void (*bfd_h_putx16) PARAMS ((bfd_vma, bfd_byte *)); - -Format dependent routines: these are vectors of entry points -within the target vector structure, one for each format to check. - -Check the format of a file being read. Return a <> or zero. - +. +. {* Format dependent routines: these are vectors of entry points +. within the target vector structure, one for each format to check. *} +. +. {* Check the format of a file being read. Return a <> or zero. *} . const struct bfd_target *(*_bfd_check_format[bfd_type_end]) PARAMS ((bfd *)); - -Set the format of a file being written. - +. +. {* Set the format of a file being written. *} . boolean (*_bfd_set_format[bfd_type_end]) PARAMS ((bfd *)); - -Write cached information into a file being written, at <>. - +. +. {* Write cached information into a file being written, at <>. *} . boolean (*_bfd_write_contents[bfd_type_end]) PARAMS ((bfd *)); - +. The general target vector. These vectors are initialized using the BFD_JUMP_TABLE macros. - . . {* Generic entry points. *} Do not "beautify" the CONCAT* macro args. Traditional C will not @@ -295,10 +280,10 @@ the tokens. . to another. *} . boolean (*_bfd_copy_private_symbol_data) PARAMS ((bfd *, asymbol *, . bfd *, asymbol *)); -. {* Called to set private backend flags *} +. {* Called to set private backend flags. *} . boolean (*_bfd_set_private_flags) PARAMS ((bfd *, flagword)); . -. {* Called to print private BFD data *} +. {* Called to print private BFD data. *} . boolean (*_bfd_print_private_bfd_data) PARAMS ((bfd *, PTR)); . . {* Core file entry points. *} @@ -448,7 +433,7 @@ the tokens. .CONCAT2 (NAME,_canonicalize_dynamic_symtab), \ .CONCAT2 (NAME,_get_dynamic_reloc_upper_bound), \ .CONCAT2 (NAME,_canonicalize_dynamic_reloc) -. {* Get the amount of memory required to hold the dynamic symbols. *} +. {* Get the amount of memory required to hold the dynamic symbols. *} . long (*_bfd_get_dynamic_symtab_upper_bound) PARAMS ((bfd *)); . {* Read in the dynamic symbols. *} . long (*_bfd_canonicalize_dynamic_symtab) @@ -466,17 +451,16 @@ and little endian code, and target chosen by the linker has the wrong endianness. The function open_output() in ld/ldlang.c uses this field to find an alternative output format that is suitable. -. {* Opposite endian version of this target. *} -. const struct bfd_target * alternative_target; +. {* Opposite endian version of this target. *} +. const struct bfd_target * alternative_target; . -Data for use by back-end routines, which isn't generic enough to belong -in this structure. - -. PTR backend_data; +. {* Data for use by back-end routines, which isn't +. generic enough to belong in this structure. *} +. PTR backend_data; . .} bfd_target; - +. */ /* All known xvecs (even those that don't compile on all systems). -- cgit v1.2.1