diff options
| author | Tom Tromey <tom@tromey.com> | 2023-02-07 21:43:37 -0700 |
|---|---|---|
| committer | Tom Tromey <tom@tromey.com> | 2023-02-15 10:27:34 -0700 |
| commit | f370ae88a81ce5775c008e9509a53d34d6707d65 (patch) | |
| tree | 72bffa54983a135f01af26b2cf1493b735a64a80 /bfd/bfd.c | |
| parent | b8e81f19cbbe978c7376795129ee90ee8e73cf0a (diff) | |
| download | gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.zip gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.tar.gz gdb-f370ae88a81ce5775c008e9509a53d34d6707d65.tar.bz2 | |
Remove RETURNS from BFD chew comments
When reading the BFD manual, I noticed text like this:
-- Function: bool bfd_close (bfd *abfd);
Close a BFD. If the BFD was open for writing, then pending
operations are completed and the file written out and closed. If
...
*Returns*
'TRUE' is returned if all is ok, otherwise 'FALSE'.
The *Returns*, like the *Synopsis* in the earlier patch, is
un-info-like. It's also used inconsistently.
This patch removes all the uses of the RETURNS word and removes it
entirely from the chew scripts. Now this example reads:
-- Function: bool bfd_close (bfd *abfd);
Close a BFD. If the BFD was open for writing, then pending
operations are completed and the file written out and closed. If
...
'TRUE' is returned if all is ok, otherwise 'FALSE'.
In a few cases I had to slightly reword the comment. There were also
a couple of cases where there was redundant text. In these cases I
just dropped the RETURNS copy.
2023-02-07 Tom Tromey <tom@tromey.com>
* bfd.c, cache.c, compress.c, opncls.c: Remove RETURNS from
documentation comments.
* doc/doc.str, doc/proto.str (RETURNS): Remove.
Diffstat (limited to 'bfd/bfd.c')
| -rw-r--r-- | bfd/bfd.c | 9 |
1 files changed, 0 insertions, 9 deletions
@@ -1841,7 +1841,6 @@ DESCRIPTION header. Use bfd_arch_bits_per_address for number of bits in the architecture address. -RETURNS Returns the arch size in bits if known, <<-1>> otherwise. */ @@ -1869,7 +1868,6 @@ DESCRIPTION return an address sign extended to fill a bfd_vma when this is the case. -RETURNS Returns <<1>> if the target architecture is known to sign extend addresses, <<0>> if the target architecture is known to not sign extend addresses, and <<-1>> otherwise. @@ -1921,7 +1919,6 @@ SYNOPSIS DESCRIPTION Make @var{vma} the entry point of output BFD @var{abfd}. -RETURNS Returns <<TRUE>> on success, <<FALSE>> otherwise. */ @@ -2485,9 +2482,6 @@ SYNOPSIS DESCRIPTION Returns the maximum page size, in bytes, as determined by emulation. - -RETURNS - Returns the maximum page size in bytes for ELF, 0 otherwise. */ bfd_vma @@ -2513,9 +2507,6 @@ SYNOPSIS DESCRIPTION Returns the common page size, in bytes, as determined by emulation. - -RETURNS - Returns the common page size in bytes for ELF, 0 otherwise. */ bfd_vma |