doc: Add gelf_getlib.3

Signed-off-by: Aaron Merey <amerey@redhat.com>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index d648e669c554c0873231254b48f8e67d9bb7be64..9917d399f0cc0937aebfaee5bf8a0c4d24e8c197 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -96,6 +96,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
                        gelf_getclass.3 \
                        gelf_getdyn.3 \
                        gelf_getehdr.3 \
+                       gelf_getlib.3 \
                        gelf_getmove.3 \
                        gelf_getphdr.3 \
                        gelf_getrel.3 \

diff --git a/doc/gelf_getlib.3 b/doc/gelf_getlib.3
new file mode 100644 (file)
index 0000000..8333579
--- /dev/null
+++ b/doc/gelf_getlib.3
@@ -0,0 +1,89 @@
+.TH GELF_GETLIB 3 2025-12-31 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+gelf_getlib \- Get prelink library from table at the given index
+
+.SH SYNOPSIS
+.nf
+.B #include <gelf.h>
+
+.BI "GElf_Lib *gelf_getlib (Elf_Data *" data ", int " ndx ", GElf_Lib *" dst ");"
+
+.SH DESCRIPTION
+Retrieve a prelink library table entry from
+.I data
+at index
+.I ndx
+and store it in the class\-independent representation pointed to by
+.IR dst .
+
+.PP
+.I data
+must be an
+.B Elf_Data*
+associated with a section of type
+.BR SHT_GNU_LIBLIST .
+.I data->d_type
+should be
+.BR ELF_T_LIB .
+.B SHT_GNU_LIBLIST
+sections are used by the prelink utility.  See
+https://sourceware.org/gnu-gabi/prelink.txt for more information.
+
+.SH PARAMETERS
+.TP
+.I data
+Pointer to an
+.B Elf_Data
+of a section with type
+.BR SHT_GNU_LIBLIST .
+.I data->d_type
+should be
+.BR ELF_T_LIB .
+
+.TP
+.I ndx
+Zero\-based index of the requested prelink library table entry within
+.IR data .
+
+.TP
+.I dst
+Pointer to a caller\-provided
+.B GElf_Lib
+structure for storing the requested prelink library table entry.
+Must not be NULL.
+
+.SH RETURN VALUE
+On success, this function updates
+.I dst
+with the requested prelink library table entry and returns
+.IR dst .
+On failure, it returns NULL and sets elf_errno.  If
+.I data
+is NULL, then NULL is returned without setting elf_errno.
+
+.SH SEE ALSO
+.BR gelf_update_lib (3),
+.BR libelf (3),
+.BR elf (5)
+
+.SH ATTRIBUTES
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.na
+.nh
+.BR gelf_getlib ()
+T}     Thread safety   MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.
+
+.SH HISTORY
+.B gelf_getlib
+first appeared in elfutils 0.95.  This function is an elfutils libelf extension and
+may not be available in other libelf implementations.