From: Aaron Merey <amerey@redhat.com>
Date: Thu, 1 Jan 2026 02:50:34 +0000 (-0500)
Subject: doc: Add gelf_getsyminfo.3
X-Git-Tag: elfutils-0.195~36
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1fac4a7aa7830009866114f7f6be2d71aa77c369;p=thirdparty%2Felfutils.git

doc: Add gelf_getsyminfo.3

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

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 62c835a8..2b2720d5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -99,6 +99,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
 			gelf_getrel.3 \
 			gelf_getrela.3 \
 			gelf_getsym.3 \
+			gelf_getsyminfo.3 \
 			gelf_getsymshndx.3 \
 			gelf_getversym.3 \
 			gelf_getverdef.3 \
diff --git a/doc/gelf_getsyminfo.3 b/doc/gelf_getsyminfo.3
new file mode 100644
index 00000000..30f5b4ad
--- /dev/null
+++ b/doc/gelf_getsyminfo.3
@@ -0,0 +1,81 @@
+.TH GELF_GETSYMINFO 3 2025-12-30 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+gelf_getsyminfo \- Retrieve class\-independent additional symbol information
+from the symbol table at the given index
+
+.SH SYNOPSIS
+.nf
+.B #include <gelf.h>
+
+.BI "GElf_Syminfo *gelf_getsyminfo (Elf_Data *" data ", int " ndx ", GElf_Syminfo *" dst ");"
+
+.SH DESCRIPTION
+Copy the additional symbol information entry from
+.I data
+at index
+.I ndx
+into the class\-independent
+.B GElf_Syminfo
+structure pointed to by
+.IR dst .
+
+.I data
+should be associated with an ELF section with type
+.B SHT_SUNW_syminfo
+and data type
+.BR ELF_T_SYMINFO .
+These types are Sun/Solaris extensions and are not typically used in GNU/Linux
+ELF files.
+
+.SH PARAMETERS
+.TP
+.I data
+Pointer to an
+.B Elf_Data
+for a section with type
+.B SHT_SUNW_syminfo
+and data type
+.BR ELF_T_SYMINFO .
+
+.TP
+.I ndx
+Zero\-based index of the additional symbol table information entry within
+.IR data .
+
+.TP
+.I dst
+Pointer to a caller\-provided structure for storing the additional symbol
+information entry.  Must not be NULL.
+
+.SH RETURN VALUE
+On success, this function copies the requested additional symbol information
+entry into
+.I *dst
+and returns
+.IR dst .
+On failure, NULL is returned and elf_errno is set.  If
+.I data
+is NULL, then NULL is returned without setting elf_errno.
+
+.SH SEE ALSO
+.BR gelf_getsym (3),
+.BR gelf_update_syminfo (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_getsyminfo ()
+T}	Thread safety	MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.