diff options
| author | Alan Modra <amodra@gmail.com> | 2023-04-30 20:42:30 +0930 |
|---|---|---|
| committer | Alan Modra <amodra@gmail.com> | 2023-05-03 15:00:05 +0930 |
| commit | 717d4bd6d199fcf834f741489aaf3bd800f9769f (patch) | |
| tree | 41ecfc03c6cd82e376d3b8bfe328842af6a7a250 /bfd/reloc.c | |
| parent | a41bd1c837f9b71b44dbb71c2d47814326cfaa8d (diff) | |
| download | binutils-gdb-717d4bd6d199fcf834f741489aaf3bd800f9769f.tar.gz | |
Generated docs and include files
bfd/doc/chew.c extracts documentation from source code comments
annotated with keywords, and generates much of bfd.h and libbfd.h from
those same comments. The docs have suffered from people (me too)
adding things like CODE_FRAGMENT to the source to put code into bfd.h
without realising that CODE_FRAGMENT also puts @example around said
code into the docs. So we have random senseless things in the docs.
This patch fixes that problem (well, the senseless things from
CODE_FRAGMENT), moves most of the code out of bfd-in.h, and improves a
few chew.c features. libbfd.h now automatically gets ATTRIBUTE_HIDDEN
prototypes, and indentation in bfd.h and libbfd.h is better.
Diffstat (limited to 'bfd/reloc.c')
| -rw-r--r-- | bfd/reloc.c | 26 |
1 files changed, 11 insertions, 15 deletions
diff --git a/bfd/reloc.c b/bfd/reloc.c index 16540632613..aab5d49bdb3 100644 --- a/bfd/reloc.c +++ b/bfd/reloc.c @@ -62,8 +62,7 @@ SUBSECTION This is the structure of a relocation entry: -CODE_FRAGMENT -. +EXTERNAL .typedef enum bfd_reloc_status .{ . {* No errors detected. Note - the value 2 is used so that it @@ -97,7 +96,9 @@ CODE_FRAGMENT . .typedef const struct reloc_howto_struct reloc_howto_type; . -.typedef struct reloc_cache_entry + +CODE_FRAGMENT +.struct reloc_cache_entry .{ . {* A pointer into the canonical table of pointers. *} . struct bfd_symbol **sym_ptr_ptr; @@ -111,8 +112,7 @@ CODE_FRAGMENT . {* Pointer to how to perform the required relocation. *} . reloc_howto_type *howto; . -.} -.arelent; +.}; . */ @@ -251,7 +251,6 @@ SUBSUBSECTION performing a relocation. CODE_FRAGMENT -. .enum complain_overflow .{ . {* Do not complain on overflow. *} @@ -270,7 +269,7 @@ CODE_FRAGMENT . unsigned number. *} . complain_overflow_unsigned .}; - +. */ /* @@ -402,11 +401,10 @@ DESCRIPTION */ /* -TYPEDEF +DEFINITION arelent_chain DESCRIPTION - How relocs are tied together in an <<asection>>: .typedef struct relent_chain @@ -1372,8 +1370,8 @@ SUBSECTION */ /* -TYPEDEF - bfd_reloc_code_type +DEFINITION + bfd_reloc_code_real_type DESCRIPTION The insides of a reloc code. The idea is that, eventually, there @@ -8134,9 +8132,10 @@ ENUMDOC ENDSENUM BFD_RELOC_UNUSED + CODE_FRAGMENT -. .typedef enum bfd_reloc_code_real bfd_reloc_code_real_type; +. */ /* @@ -8154,7 +8153,6 @@ DESCRIPTION Return a pointer to a howto structure which, when invoked, will perform the relocation @var{code} on data from the architecture noted. - */ reloc_howto_type * @@ -8182,7 +8180,6 @@ SYNOPSIS DESCRIPTION Provides a default relocation lookup routine for any architecture. - */ reloc_howto_type * @@ -8329,7 +8326,6 @@ SYNOPSIS DESCRIPTION Provides default handling of relocation effort for back ends which can't be bothered to do it efficiently. - */ bfd_byte * |