Signed-off-by: Aaron Merey <ame...@redhat.com>
---
 doc/elf32_checksum.3 | 47 ++++++++++++++++++++++++++++++++++++++++++++
 doc/elf64_checksum.3 | 47 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 94 insertions(+)
 create mode 100644 doc/elf32_checksum.3
 create mode 100644 doc/elf64_checksum.3

diff --git a/doc/elf32_checksum.3 b/doc/elf32_checksum.3
new file mode 100644
index 00000000..617b955c
--- /dev/null
+++ b/doc/elf32_checksum.3
@@ -0,0 +1,47 @@
+.TH ELF32_CHECKSUM 3 2024-08-14 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf32_checksum \- compute the checksum for an ELF32 object file
+
+.SH SYNOPSIS
+.B #include <libelf.h>
+
+.BI "long int elf32_checksum(Elf *" elf ");"
+
+.SH DESCRIPTION
+Compute a checksum for the ELF32 object file referred to by
+.I elf.
+The checksum is computed from permanent parts of the ELF file and
+the result is repeatable.
+
+.SH PARAMETERS
+.TP
+.I elf
+The ELF32 object file for which the checksum is to be computed.
+
+.SH RETURN VALUE
+On success, return the computed checksum. If an error occurs, return -1 and 
set a libelf error code.
+
+.SH SEE ALSO
+.BR elf_errno (3),
+.BR elf64_checksum (3),
+.BR libelf (3),
+.BR elf (5)
+
+.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 elf32_checksum ()
+T}     Thread safety   MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or 
https://sourceware.org/bugzilla/.
diff --git a/doc/elf64_checksum.3 b/doc/elf64_checksum.3
new file mode 100644
index 00000000..916cedaa
--- /dev/null
+++ b/doc/elf64_checksum.3
@@ -0,0 +1,47 @@
+.TH ELF64_CHECKSUM 3 2024-08-14 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf64_checksum \- compute the checksum for an ELF64 object file
+
+.SH SYNOPSIS
+.B #include <libelf.h>
+
+.BI "long int elf64_checksum(Elf *" elf ");"
+
+.SH DESCRIPTION
+Compute a checksum for the ELF64 object file referred to by
+.I elf.
+The checksum is computed from permanent parts of the ELF file and
+the result is repeatable.
+
+.SH PARAMETERS
+.TP
+.I elf
+The ELF64 object file for which the checksum is to be computed.
+
+.SH RETURN VALUE
+On success, return the computed checksum. If an error occurs, return -1 and 
set a libelf error code.
+
+.SH SEE ALSO
+.BR elf_errno (3),
+.BR elf32_checksum (3),
+.BR libelf (3),
+.BR elf (5)
+
+.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 elf64_checksum ()
+T}     Thread safety   MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or 
https://sourceware.org/bugzilla/.
-- 
2.46.0

Reply via email to