diff mbox series

[9/9] doc: Add elf32_xlatetom.3 and elf64_xlatetom.3

Message ID 20240814213321.244089-9-amerey@redhat.com
State Superseded
Delegated to: Mark Wielaard
Headers
Series [1/9] doc: Add elf32_checksum.3 and elf64_checksum.3 |

Commit Message

Aaron Merey Aug. 14, 2024, 9:33 p.m. UTC 
  Signed-off-by: Aaron Merey <amerey@redhat.com>
---
 doc/elf32_xlatetom.3 | 61 ++++++++++++++++++++++++++++++++++++++++++++
 doc/elf64_xlatetom.3 | 61 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 122 insertions(+)
 create mode 100644 doc/elf32_xlatetom.3
 create mode 100644 doc/elf64_xlatetom.3
diff mbox series

Patch

diff --git a/doc/elf32_xlatetom.3 b/doc/elf32_xlatetom.3
new file mode 100644
index 00000000..35d9dc6e
--- /dev/null
+++ b/doc/elf32_xlatetom.3
@@ -0,0 +1,61 @@ 
+.TH ELF32_XLATETOM 3 2024-08-14 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf32_xlatetom \- translate ELF32 data from file representation to memory representation
+
+.SH SYNOPSIS
+.B #include <libelf.h>
+
+.BI "int elf32_xlatetom(Elf_Data *" dst ", const Elf_Data *" src ", unsigned int " encoding ");"
+
+.SH DESCRIPTION
+Translates ELF32 data from its file representation to its memory representation.
+
+.SH PARAMETERS
+.TP
+.I dst
+Destination where the translated data will be stored.
+
+.TP
+.I src
+Source data in its file representation.
+
+.TP
+.I encoding
+The encoding of the source data.
+.I encoding
+can be either
+.B ELFDATA2LSB
+(two's complement little-endian) or
+.B ELFDATA2MSB
+(two's complement big-endian).
+
+.SH RETURN VALUE
+Return
+.I dest
+on success. If an error occurs, return NULL and set a libelf error code.
+
+.SH SEE ALSO
+.BR elf_errno (3),
+.BR elf32_xlatetof (3),
+.BR elf64_xlatetom (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_xlatetom ()
+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_xlatetom.3 b/doc/elf64_xlatetom.3
new file mode 100644
index 00000000..70098013
--- /dev/null
+++ b/doc/elf64_xlatetom.3
@@ -0,0 +1,61 @@ 
+.TH ELF64_XLATETOM 3 2024-08-14 "Libelf" "Libelf Programmer's Manual"
+
+.SH NAME
+elf64_xlatetom \- translate ELF64 data from file representation to memory representation
+
+.SH SYNOPSIS
+.B #include <libelf.h>
+
+.BI "int elf64_xlatetom(Elf_Data *" dst ", const Elf_Data *" src ", unsigned int " encoding ");"
+
+.SH DESCRIPTION
+Translates ELF64 data from its file representation to its memory representation.
+
+.SH PARAMETERS
+.TP
+.I dst
+Destination where the translated data will be stored.
+
+.TP
+.I src
+Source data in its file representation.
+
+.TP
+.I encoding
+The encoding of the source data.
+.I encoding
+can be either
+.B ELFDATA2LSB
+(two's complement little-endian) or
+.B ELFDATA2MSB
+(two's complement big-endian).
+
+.SH RETURN VALUE
+Return
+.I dest
+on success. If an error occurs, return NULL and set a libelf error code.
+
+.SH SEE ALSO
+.BR elf_errno (3),
+.BR elf32_xlatetom (3),
+.BR elf64_xlatetof (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_xlatetom ()
+T}	Thread safety	MT-Safe
+.TE
+
+.SH REPORTING BUGS
+Report bugs to <elfutils-devel@sourceware.org> or https://sourceware.org/bugzilla/.