Hi Aaron,
On Tue, 2025-04-01 at 00:05 -0400, Aaron Merey wrote:
> diff --git a/doc/elf_kind.3 b/doc/elf_kind.3
> new file mode 100644
> index 00000000..3caa2724
> --- /dev/null
> +++ b/doc/elf_kind.3
> @@ -0,0 +1,71 @@
> +.TH ELF_KIND 3 2025-03-31 "Libelf" "Libelf Programmer's Manual"
> +
> +.SH NAME
> +elf_kind \- Determine the type of file represented by an ELF descriptor.
> +
> +.SH SYNOPSIS
> +.nf
> +#include <libelf.h>
> +
> +.BI "Elf_Kind elf_kind(Elf *" elf ");"
> +
> +.SH DESCRIPTION
> +The
> +.B elf_kind
> +function determines the file type of the file represented by
> +.IR elf .
> +This type identifies whether the descriptor represents an
> +ELF object, an archive member, or some other type of file.
> +
> +.SH PARAMETERS
> +.TP
> +.I elf
> +The ELF descriptor.
> +
> +.SH RETURN VALUE
> +The file type of the file represented by
> +.IR elf .
> +The possible return value are
> +
> +.RS
> +.TP
> +.PD 0
> +.TP
> +.TP
> +.B ELF_K_NONE
> +Unknown file type.
> +
> +.TP
> +.B ELF_K_AR
> +Archive member.
> +
> +.TP
> +.B ELF_K_COFF
> +COFF object file.
Maybe mention that elfutils libelf doesn't support COFF object files?
> +
> +.TP
> +.B ELF_K_ELF
> +ELF object file.
> +
> +
> +.SH SEE ALSO
> +.BR libelf (3),
> +.BR elf (5)
elf.5 doesn't describe the ar format, should it? Or should we have an
ar.5 man page?
> +
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lbx lb lb
> +l l l.
> +Interface Attribute Value
> +T{
> +.na
> +.nh
> +.BR elf_kind ()
> +T} Thread safety MT-Safe
> +.TE
> +
> +.SH REPORTING BUGS
> +Report bugs to <elfutils-devel@sourceware.org> or
> https://sourceware.org/bugzilla/.
Cheers,
Mark
