diff mbox series

[5/7,v3] doc: Add elf_getarhdr.3

Message ID 20250715042557.708628-5-amerey@redhat.com
State Committed
Delegated to: Mark Wielaard
Headers
Series [1/7] elf_getaroff: Fix elf_getaroff error return value |

Commit Message

Aaron Merey July 15, 2025, 4:25 a.m. UTC 
  Signed-off-by: Aaron Merey <amerey@redhat.com>

---
v3: Remove mention of elf_rand and elf_next invalidating Elf_Arhdr.
Change thread safety attribute to MT-safe.

 doc/Makefile.am    |  1 +
 doc/elf_getarhdr.3 | 78 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 79 insertions(+)
 create mode 100644 doc/elf_getarhdr.3

Comments

Mark Wielaard July 17, 2025, 5:35 p.m. UTC | #1 
Hi Aaron,

On Tue, 2025-07-15 at 00:25 -0400, Aaron Merey wrote:
> Signed-off-by: Aaron Merey <amerey@redhat.com>
> 
> ---
> v3: Remove mention of elf_rand and elf_next invalidating Elf_Arhdr.
> Change thread safety attribute to MT-safe.

Yes, looks correct to me.

I am not sure your patch "elf_getarhdr: Replace per-archive Elf_Arhdr
storage with per-member storage" completely does that (yet).

But lets go with this documentation because that is the goal.

Cheers,

Mark
diff mbox series

Patch

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 6451ffab..aae29ebc 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -55,6 +55,7 @@  notrans_dist_man3_MANS= elf32_checksum.3 \
 			elf_errmsg.3 \
 			elf_errno.3 \
 			elf_fill.3 \
+			elf_getarhdr.3 \
 			elf_getaroff.3 \
 			elf_getbase.3 \
 			elf_getdata.3 \
diff --git a/doc/elf_getarhdr.3 b/doc/elf_getarhdr.3
new file mode 100644
index 00000000..6ad90c69
--- /dev/null
+++ b/doc/elf_getarhdr.3
@@ -0,0 +1,78 @@ 
+.TH ELF_GETARHDR 3 2025-06-06 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf_getarhdr \- retrieve archive member header information
+
+.SH SYNOPSIS
+.nf
+.B #include <libelf.h>
+
+.BI "Elf_Arhdr *elf_getarhdr(Elf *" elf ");"
+.fi
+
+.SH DESCRIPTION
+Return a
+.B Elf_Arhdr *
+describing the archive header of the archive member currently referred
+to by an ELF descriptor.
+
+The
+.B Elf_Arhdr
+structure is defined as:
+
+.P
+.nf
+typedef struct {
+  char *ar_name;                /* Name of archive member.  */
+  time_t ar_date;               /* File date.  */
+  uid_t ar_uid;                 /* User ID.  */
+  gid_t ar_gid;                 /* Group ID.  */
+  mode_t ar_mode;               /* File mode.  */
+  int64_t ar_size;              /* File size.  */
+  char *ar_rawname;             /* Original name of archive member.  */
+} Elf_Arhdr;
+.fi
+
+.SH PARAMETERS
+.TP
+.I elf
+An ELF descriptor referring to a member of an archive file.
+
+.SH RETURN VALUE
+If
+.I elf
+refers to an archive member,
+.B elf_getarhdr()
+returns a pointer to its archive header.
+This pointer is valid until
+.I elf
+or the parent archive Elf descriptor are closed using
+.BR elf_end() .
+If
+.I elf
+does not refer to an archive member or the header cannot be
+acquired then NULL is returned.
+
+.SH SEE ALSO
+.BR elf_begin (3),
+.BR elf_getaroff (3),
+.BR elf_next (3),
+.BR elf_rand (3),
+.BR libelf (3),
+.BR elf (5)
+
+.SH ATTRIBUTES
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.na
+.nh
+.BR elf_getarhdr ()
+T}	Thread safety	MT-safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.