Hi Aaron,
On Sun, 2025-09-14 at 19:21 -0400, Aaron Merey wrote:
> Signed-off-by: Aaron Merey <[email protected]>
> ---
> doc/Makefile.am | 1 +
> doc/gelf_getclass.3 | 63 +++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 64 insertions(+)
> create mode 100644 doc/gelf_getclass.3
>
> 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
OK.
> # libdebuginfod man pages (also notrans)
> diff --git a/doc/gelf_getclass.3 b/doc/gelf_getclass.3
> new file mode 100644
> index 00000000..6342330b
> --- /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
OK.
> +.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 uses the 32\-bit ELF class.
> +.TP
> +.B ELFCLASS64
> +The object uses the 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.
OK. Not a native English speaker, but I would expect "The object is a
..." instead of "uses". Might just be fine though.
> +.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.
OK.
> +.SH SEE ALSO
> +.BR elf_kind (3),
> +.BR libelf (3),
> +.BR elf (5)
OK.
> +.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 <[email protected]> or
> https://sourceware.org/bugzilla/.
Looks good.
Thanks,
Mark
