From: Aaron Merey <amerey@redhat.com>
Date: Sun, 14 Sep 2025 23:21:01 +0000 (-0400)
Subject: doc: Add gelf_getclass.3
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ffd4a81494f4377b01ee92e338ad5ed3dc2e05b3;p=thirdparty%2Felfutils.git

doc: Add gelf_getclass.3

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

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 96d35d20..1230480e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -91,6 +91,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
 			elf_strptr.3 \
 			elf_update.3 \
 			elf_version.3 \
+			gelf_getclass.3 \
 			libelf.3
 
 # libdebuginfod man pages (also notrans)
diff --git a/doc/gelf_getclass.3 b/doc/gelf_getclass.3
new file mode 100644
index 00000000..25d517db
--- /dev/null
+++ b/doc/gelf_getclass.3
@@ -0,0 +1,63 @@
+.TH GELF_GETCLASS 3 2025-09-14 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+gelf_getclass \- return the ELF class (32\-bit or 64\-bit) for an object
+.SH SYNOPSIS
+.nf
+.B #include <gelf.h>
+
+.BI "int gelf_getclass(Elf *" elf ");"
+.fi
+
+.SH DESCRIPTION
+.BR gelf_getclass ()
+returns the class of the ELF object referenced by
+.IR elf .
+The class of a valid ELF file will be one of:
+.TP
+.B ELFCLASS32
+The object is a 32\-bit ELF class.
+.TP
+.B ELFCLASS64
+The object is a 64\-bit ELF class.
+.PP
+If
+.I elf
+does not denote a valid ELF object, or the class cannot be determined,
+.B ELFCLASSNONE
+is returned.
+
+.SH RETURN VALUE
+Returns
+.B ELFCLASS32
+or
+.B ELFCLASS64
+on success.
+If
+.I elf
+is NULL or does not refer to a valid ELF binary with kind
+.BR ELF_K_ELF ,
+then
+.B ELFCLASSNONE
+is returned.
+
+.SH SEE ALSO
+.BR elf_kind (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_getclass ()
+T}	Thread safety	MT-unsafe race
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.