From f370ae88a81ce5775c008e9509a53d34d6707d65 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Tue, 7 Feb 2023 21:43:37 -0700 Subject: 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 * bfd.c, cache.c, compress.c, opncls.c: Remove RETURNS from documentation comments. * doc/doc.str, doc/proto.str (RETURNS): Remove. --- bfd/bfd.c | 9 --------- 1 file changed, 9 deletions(-) (limited to 'bfd/bfd.c') diff --git a/bfd/bfd.c b/bfd/bfd.c index c59e31d..3624bfb 100644 --- a/bfd/bfd.c +++ b/bfd/bfd.c @@ -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 <> on success, <> 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 -- cgit v1.1