Hi Aaron,

On Wed, 2025-12-31 at 21:50 -0500, Aaron Merey wrote:
> Signed-off-by: Aaron Merey <[email protected]>
> ---
>  doc/Makefile.am    |  1 +
>  doc/gelf_getmove.3 | 70 ++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 71 insertions(+)
>  create mode 100644 doc/gelf_getmove.3
> 
> diff --git a/doc/Makefile.am b/doc/Makefile.am
> index 89a1834c..5ef3eb3b 100644
> --- a/doc/Makefile.am
> +++ b/doc/Makefile.am
> @@ -96,6 +96,7 @@ notrans_dist_man3_MANS= elf32_checksum.3 \
>                       gelf_getclass.3 \
>                       gelf_getdyn.3 \
>                       gelf_getehdr.3 \
> +                     gelf_getmove.3 \
>                       gelf_getphdr.3 \
>                       gelf_getrel.3 \
>                       gelf_getrela.3 \

OK.

> diff --git a/doc/gelf_getmove.3 b/doc/gelf_getmove.3
> new file mode 100644
> index 00000000..70bdf59e
> --- /dev/null
> +++ b/doc/gelf_getmove.3
> @@ -0,0 +1,70 @@
> +.TH GELF_GETMOVE 3 2025-12-30 "Libelf" "Libelf Programmer's Manual"
> +
> +.SH NAME
> +gelf_getmove \- Get move structure at the given index
> +
> +.SH SYNOPSIS
> +.nf
> +.B #include <gelf.h>
> +
> +.BI "GElf_Move *gelf_getmove (Elf_Data *" data ", int " ndx ", GElf_Move *" 
> dst ");"

OK.

> +.SH DESCRIPTION
> +Copy a move structure at index
> +.I ndx
> +from a
> +.B SHT_SUNW_move
> +section associated with
> +.I data
> +into a class\-independent representation stored in
> +.IR *dst .

data d_type should be ELF_T_MOVE.
Probably should be mentioned 

It has no use or tests associated with it.
See also gelf_update_move which I believe just doesn't work...

> +.SH PARAMETERS
> +.TP
> +.I data
> +Pointer to an
> +.B Elf_Data
> +of an
> +.B SHT_SUNW_move
> +section.
> +
> +.TP
> +.I ndx
> +Zero\-based index of the move structure in
> +.IR data .
> +
> +.TP
> +.I dst
> +Pointer to a caller\-provided structure for storing the requested move entry.
> +.I dst
> +must not be NULL.

OK.

> +.SH RETURN VALUE
> +On success, this function stores the requested move structure in
> +.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_update_move (3),
> +.BR libelf (3),
> +.BR elf (5)

OK. Where is GElf_Move described? It is just Elf64_Move, but that isn't
mentioned anywhere?

> +.SH ATTRIBUTES
> +.TS
> +allbox;
> +lbx lb lb
> +l l l.
> +Interface    Attribute       Value
> +T{
> +.na
> +.nh
> +.BR gelf_getmove ()
> +T}   Thread safety   MT-Safe
> +.TE
> +
> +.SH REPORTING BUGS
> +Report bugs to <[email protected]> or 
> https://sourceware.org/bugzilla/.

OK.

Thanks,

Mark

Reply via email to