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

doc: Add gelf_update_syminfo.3

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

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2b2720d5..38357429 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -116,6 +116,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
 			gelf_update_rel.3 \
 			gelf_update_rela.3 \
 			gelf_update_sym.3 \
+			gelf_update_syminfo.3 \
 			gelf_update_symshndx.3 \
 			gelf_update_versym.3 \
 			gelf_update_verdef.3 \
diff --git a/doc/gelf_update_syminfo.3 b/doc/gelf_update_syminfo.3
new file mode 100644
index 00000000..c02dcd58
--- /dev/null
+++ b/doc/gelf_update_syminfo.3
@@ -0,0 +1,87 @@
+.TH GELF_UPDATE_SYMINFO 3 2025-12-30 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+gelf_update_syminfo \- Update additional symbol information in the symbol table at the given index
+
+.SH SYNOPSIS
+.nf
+.B #include <gelf.h>
+
+.BI "int gelf_update_syminfo (Elf_Data *" data ", int " ndx ", GElf_Syminfo *" src ");"
+
+.SH DESCRIPTION
+Copy a class\-independent additional symbol information entry from
+.I src
+into the
+.B SHT_SUNW_syminfo
+section associated with
+.I data
+at entry index
+.IR ndx .
+
+.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
+associated with an ELF section with type
+for a section with type
+.B SHT_SUNW_syminfo
+and data type
+.BR ELF_T_SYMINFO .
+
+.TP
+.I ndx
+Zero\-based index of the entry in
+.I data
+to be updated.
+
+.TP
+.I src
+Pointer to a caller\-provided additional symbol information entry.  Must not
+be NULL.
+
+.SH RETURN VALUE
+On success, this function returns a non-zero value and updates
+.I data
+with
+.I src
+at index
+.IR ndx .
+The section associated with
+.I data
+is flagged with
+.BR ELF_F_DIRTY .
+On failure, zero is returned and elf_errno is set.  If
+.I data
+is NULL, then zero is returned without setting elf_errno.
+
+.SH SEE ALSO
+.BR gelf_getsym (3),
+.BR gelf_getsyminfo (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_update_syminfo ()
+T}	Thread safety	MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.