Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/external/bsd/elftoolchain/dist/libelf Sync libelf's manual p...
details: https://anonhg.NetBSD.org/src/rev/62ff5d5f3328
branches: trunk
changeset: 363452:62ff5d5f3328
user: jkoshy <jkoshy%NetBSD.org@localhost>
date: Sat Mar 12 21:37:55 2022 +0000
description:
Sync libelf's manual pages with upstream [r3963].
diffstat:
external/bsd/elftoolchain/dist/libelf/elf_begin.3 | 90 +++++++-------
external/bsd/elftoolchain/dist/libelf/elf_cntl.3 | 24 ++--
external/bsd/elftoolchain/dist/libelf/elf_end.3 | 16 +-
external/bsd/elftoolchain/dist/libelf/elf_errmsg.3 | 10 +-
external/bsd/elftoolchain/dist/libelf/elf_flagdata.3 | 40 +++---
external/bsd/elftoolchain/dist/libelf/elf_getarhdr.3 | 10 +-
external/bsd/elftoolchain/dist/libelf/elf_getarsym.3 | 18 +-
external/bsd/elftoolchain/dist/libelf/elf_getbase.3 | 8 +-
external/bsd/elftoolchain/dist/libelf/elf_getdata.3 | 54 ++++----
external/bsd/elftoolchain/dist/libelf/elf_getident.3 | 14 +-
external/bsd/elftoolchain/dist/libelf/elf_getphdrnum.3 | 16 +-
external/bsd/elftoolchain/dist/libelf/elf_getphnum.3 | 16 +-
external/bsd/elftoolchain/dist/libelf/elf_getscn.3 | 34 ++--
external/bsd/elftoolchain/dist/libelf/elf_getshdrnum.3 | 14 +-
external/bsd/elftoolchain/dist/libelf/elf_getshdrstrndx.3 | 16 +-
external/bsd/elftoolchain/dist/libelf/elf_getshnum.3 | 14 +-
external/bsd/elftoolchain/dist/libelf/elf_getshstrndx.3 | 18 +-
external/bsd/elftoolchain/dist/libelf/elf_hash.3 | 6 +-
external/bsd/elftoolchain/dist/libelf/elf_kind.3 | 16 +-
external/bsd/elftoolchain/dist/libelf/elf_memory.3 | 14 +-
external/bsd/elftoolchain/dist/libelf/elf_next.3 | 12 +-
external/bsd/elftoolchain/dist/libelf/elf_open.3 | 20 +-
external/bsd/elftoolchain/dist/libelf/elf_rand.3 | 18 +-
external/bsd/elftoolchain/dist/libelf/elf_rawfile.3 | 12 +-
external/bsd/elftoolchain/dist/libelf/elf_strptr.3 | 30 ++--
external/bsd/elftoolchain/dist/libelf/elf_update.3 | 38 +++---
external/bsd/elftoolchain/dist/libelf/elf_version.3 | 14 +-
external/bsd/elftoolchain/dist/libelf/gelf_checksum.3 | 24 ++--
external/bsd/elftoolchain/dist/libelf/gelf_fsize.3 | 20 +-
external/bsd/elftoolchain/dist/libelf/gelf_getcap.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getclass.3 | 10 +-
external/bsd/elftoolchain/dist/libelf/gelf_getdyn.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getehdr.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getmove.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getphdr.3 | 28 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getrel.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getrela.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getshdr.3 | 24 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getsym.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getsyminfo.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_getsymshndx.3 | 64 +++++-----
external/bsd/elftoolchain/dist/libelf/gelf_newehdr.3 | 32 ++--
external/bsd/elftoolchain/dist/libelf/gelf_newphdr.3 | 24 ++--
external/bsd/elftoolchain/dist/libelf/gelf_update_ehdr.3 | 34 ++--
external/bsd/elftoolchain/dist/libelf/gelf_xlatetof.3 | 44 +++---
45 files changed, 576 insertions(+), 576 deletions(-)
diffs (truncated from 3833 to 300 lines):
diff -r b554ef548327 -r 62ff5d5f3328 external/bsd/elftoolchain/dist/libelf/elf_begin.3
--- a/external/bsd/elftoolchain/dist/libelf/elf_begin.3 Sat Mar 12 21:15:25 2022 +0000
+++ b/external/bsd/elftoolchain/dist/libelf/elf_begin.3 Sat Mar 12 21:37:55 2022 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: elf_begin.3,v 1.4 2021/03/08 20:55:06 jkoshy Exp $
+.\" $NetBSD: elf_begin.3,v 1.5 2022/03/12 21:37:55 jkoshy Exp $
.\"
.\" Copyright (c) 2006,2008-2011 Joseph Koshy. All rights reserved.
.\"
@@ -23,7 +23,7 @@
.\" out of the use of this software, even if advised of the possibility of
.\" such damage.
.\"
-.\" Id: elf_begin.3 3928 2021-03-07 19:47:55Z jkoshy
+.\" Id: elf_begin.3 3952 2022-03-12 09:09:50Z jkoshy
.\"
.Dd December 11, 2011
.Dt ELF_BEGIN 3
@@ -54,22 +54,22 @@
APIs.
.Pp
Argument
-.Ar fd
+.Fa fd
is an open file descriptor returned from an
.Xr open 2
system call.
Function
.Fn elf_begin
uses argument
-.Ar fd
+.Fa fd
for reading or writing depending on the value of argument
-.Ar cmd .
+.Fa cmd .
Argument
-.Ar elf
+.Fa elf
is primarily used for iterating through archives.
.Pp
The argument
-.Ar cmd
+.Fa cmd
can have the following values:
.Bl -tag -width "ELF_C_WRITE"
.It ELF_C_NULL
@@ -78,46 +78,46 @@
to return
.Dv NULL .
Arguments
-.Ar fd
+.Fa fd
and
-.Ar elf
+.Fa elf
are ignored, and no additional error is signalled.
.It ELF_C_READ
This value is to be when the application wishes to examine (but not
modify) the contents of the file specified by the arguments
-.Ar fd
+.Fa fd
and
-.Ar elf .
+.Fa elf .
It can be used for both
.Xr ar 1
archives and for ELF objects.
.Pp
If argument
-.Ar elf
+.Fa elf
is
.Dv NULL ,
the library will allocate a new ELF descriptor for the file
being processed.
The argument
-.Ar fd
+.Fa fd
should have been opened for reading.
.Pp
If argument
-.Ar elf
+.Fa elf
is not
.Dv NULL ,
and references a regular ELF file previously opened with
.Fn elf_begin ,
then the activation count for the descriptor referenced by argument
-.Ar elf
+.Fa elf
is incremented.
The value in argument
-.Ar fd
+.Fa fd
should match that used to open the descriptor argument
-.Ar elf .
+.Fa elf .
.Pp
If argument
-.Ar elf
+.Fa elf
is not
.Dv NULL ,
and references a descriptor for an
@@ -129,11 +129,11 @@
.Sx "Processing ar(1) archives"
below.
The value for argument
-.Ar fd
+.Fa fd
should match that used to open the archive earlier.
.Pp
If argument
-.Ar elf
+.Fa elf
is not
.Dv NULL ,
and references an
@@ -141,7 +141,7 @@
archive opened earlier with
.Fn elf_memory ,
then the value of the argument
-.Ar fd
+.Fa fd
is ignored.
.It Dv ELF_C_RDWR
This command is used to prepare an ELF file for reading and writing.
@@ -150,25 +150,25 @@
archives.
.Pp
Argument
-.Ar fd
+.Fa fd
should have been opened for reading and writing.
If argument
-.Ar elf
+.Fa elf
is
.Dv NULL ,
the library will allocate a new ELF descriptor for
the file being processed.
If the argument
-.Ar elf
+.Fa elf
is non-null, it should point to a descriptor previously
allocated with
.Fn elf_begin
with the same values for arguments
-.Ar fd
+.Fa fd
and
-.Ar cmd ;
+.Fa cmd ;
in this case the library will increment the activation count for descriptor
-.Ar elf
+.Fa elf
and return the same descriptor.
.Pp
Changes to the in-memory image of the ELF file may be written back to
@@ -179,19 +179,19 @@
This command is used when the application wishes to create a new ELF
file.
Argument
-.Ar fd
+.Fa fd
should have been opened for writing.
Argument
-.Ar elf
+.Fa elf
is ignored, and the previous contents of file referenced by argument
-.Ar fd
+.Fa fd
are overwritten.
.El
.Ss Processing ar(1) archives
An
.Xr ar 1
archive may be opened in read mode (with argument
-.Ar cmd
+.Fa cmd
set to
.Dv ELF_C_READ )
using
@@ -258,53 +258,53 @@
.Bl -tag -width "[ELF_E_RESOURCE]"
.It Bq Er ELF_E_ARCHIVE
The archive denoted by argument
-.Ar elf
+.Fa elf
could not be parsed.
.It Bq Er ELF_E_ARGUMENT
The value in argument
-.Ar cmd
+.Fa cmd
was unrecognized.
.It Bq Er ELF_E_ARGUMENT
A non-null value for argument
-.Ar elf
+.Fa elf
was specified when
-.Ar cmd
+.Fa cmd
was set to
.Dv ELF_C_RDWR .
.It Bq Er ELF_E_ARGUMENT
The value of argument
-.Ar fd
+.Fa fd
differs from the one the ELF descriptor
-.Ar elf
+.Fa elf
was created with.
.It Bq Er ELF_E_ARGUMENT
Argument
-.Ar cmd
+.Fa cmd
differs from the value specified when ELF descriptor
-.Ar elf
+.Fa elf
was created.
.It Bq Er ELF_E_ARGUMENT
An
.Xr ar 1
archive was opened with
-.Ar cmd
+.Fa cmd
set to
.Dv ELF_C_RDWR .
.It Bq Er ELF_E_ARGUMENT
The file referenced by argument
-.Ar fd
+.Fa fd
was empty.
.It Bq Er ELF_E_ARGUMENT
The underlying file for argument
-.Ar fd
+.Fa fd
was of an unsupported type.
.It Bq Er ELF_E_IO
The file descriptor in argument
-.Ar fd
+.Fa fd
was invalid.
.It Bq Er ELF_E_IO
The file descriptor in argument
-.Ar fd
+.Fa fd
could not be read or written to.
.It Bq Er ELF_E_RESOURCE
An out of memory condition was encountered.
@@ -315,7 +315,7 @@
.Xr elf_version 3 .
.It Bq Er ELF_E_VERSION
The ELF object referenced by argument
-.Ar fd
+.Fa fd
was of an unsupported ELF version.
.El
.Sh SEE ALSO
diff -r b554ef548327 -r 62ff5d5f3328 external/bsd/elftoolchain/dist/libelf/elf_cntl.3
--- a/external/bsd/elftoolchain/dist/libelf/elf_cntl.3 Sat Mar 12 21:15:25 2022 +0000
+++ b/external/bsd/elftoolchain/dist/libelf/elf_cntl.3 Sat Mar 12 21:37:55 2022 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: elf_cntl.3,v 1.4 2021/03/08 20:55:06 jkoshy Exp $
+.\" $NetBSD: elf_cntl.3,v 1.5 2022/03/12 21:37:55 jkoshy Exp $
.\"
.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved.
.\"
@@ -23,7 +23,7 @@
.\" out of the use of this software, even if advised of the possibility of
.\" such damage.
.\"
-.\" Id: elf_cntl.3 3928 2021-03-07 19:47:55Z jkoshy
+.\" Id: elf_cntl.3 3953 2022-03-12 09:57:05Z jkoshy
.\"
.Dd August 9, 2006
.Dt ELF_CNTL 3
@@ -42,34 +42,34 @@
.Fn elf_cntl
controls the ELF library's subsequent use of the file descriptor
used to create ELF descriptor
-.Ar elf .
+.Fa elf .
.Pp
Argument
-.Ar cmd
+.Fa cmd
informs the library of the action to be taken:
.Bl -tag -width "ELF_C_FDDONE"
.It Dv ELF_C_FDDONE
This value instructs the ELF library not to perform any further
I/O on the file descriptor associated with argument
-.Ar elf .
+.Fa elf .
For ELF descriptors opened with mode
-.Ar ELF_C_WRITE
+.Dv ELF_C_WRITE
or
-.Ar ELF_C_RDWR
+.Dv ELF_C_RDWR
Home |
Main Index |
Thread Index |
Old Index