diff options
| author | David MacKenzie <djm@cygnus> | 1993-11-05 19:51:52 +0000 |
|---|---|---|
| committer | David MacKenzie <djm@cygnus> | 1993-11-05 19:51:52 +0000 |
| commit | c188b0bec3b6f147efe7474a606799ed7185d806 (patch) | |
| tree | 880b6ef2d75443502b96d143f5e4d4244d1a5e15 /bfd/libbfd.c | |
| parent | 5090e82cca377dd12046a4bb7dc1922f363348b4 (diff) | |
| download | binutils-c188b0bec3b6f147efe7474a606799ed7185d806.zip binutils-c188b0bec3b6f147efe7474a606799ed7185d806.tar.gz binutils-c188b0bec3b6f147efe7474a606799ed7185d806.tar.bz2 | |
doc cleanup
Diffstat (limited to 'bfd/libbfd.c')
| -rw-r--r-- | bfd/libbfd.c | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/bfd/libbfd.c b/bfd/libbfd.c index 1c93970..90e100d 100644 --- a/bfd/libbfd.c +++ b/bfd/libbfd.c @@ -27,7 +27,7 @@ SECTION libbfd DESCRIPTION - This file contains various routines which are used within BFD. + These routines are used within BFD. They are not intended for export, but are documented here for completeness. */ @@ -138,7 +138,7 @@ SYNOPSIS PTR bfd_xmalloc( bfd_size_type size); DESCRIPTION - Like malloc, but exit if no more memory. + Like <<malloc>>, but exit if no more memory. */ @@ -157,7 +157,7 @@ DEFUN(PTR bfd_xmalloc,(size), if (!ptr) { write (2, no_memory_message, sizeof(no_memory_message)-1); - exit (-1); + exit (1); } return ptr; } @@ -170,8 +170,8 @@ SYNOPSIS PTR bfd_xmalloc_by_size_t ( size_t size); DESCRIPTION - Like malloc, but exit if no more memory. - Uses size_t, so it's suitable for use as obstack_chunk_alloc. + Like <<malloc>>, but exit if no more memory. + Uses <<size_t>>, so it's suitable for use as <<obstack_chunk_alloc>>. */ PTR DEFUN(bfd_xmalloc_by_size_t, (size), @@ -246,8 +246,8 @@ SYNOPSIS void bfd_write_bigendian_4byte_int(bfd *abfd, int i); DESCRIPTION - Writes a 4 byte integer to the outputing bfd, in big endian - mode regardless of what else is going on. This is useful in + Write a 4 byte integer @var{i} to the output BFD @var{abfd}, in big + endian order regardless of what else is going on. This is useful in archives. */ @@ -501,15 +501,14 @@ DESCRIPTION /* FUNCTION bfd_h_put_size -FUNCTION bfd_h_get_size DESCRIPTION These macros have the same function as their <<bfd_get_x>> - bretherin, except that they are used for removing information + bretheren, except that they are used for removing information for the header records of object files. Believe it or not, some object files keep their header records in big endian - order, and their data in little endian order. + order and their data in little endian order. . .{* Byte swapping macros for file header data. *} . @@ -850,8 +849,8 @@ INTERNAL_FUNCTION bfd_log2 DESCRIPTION - Return the log base 2 of the value supplied, rounded up. eg an - arg of 1025 would return 11. + Return the log base 2 of the value supplied, rounded up. E.g., an + @var{x} of 1025 returns 11. SYNOPSIS unsigned int bfd_log2(bfd_vma x); |