From patchwork Wed Aug 14 21:33:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aaron Merey X-Patchwork-Id: 95879 X-Patchwork-Delegate: mark@klomp.org Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id E55D73858294 for ; Wed, 14 Aug 2024 21:34:13 +0000 (GMT) X-Original-To: elfutils-devel@sourceware.org Delivered-To: elfutils-devel@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTP id D2AEA385841C for ; Wed, 14 Aug 2024 21:33:35 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org D2AEA385841C Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org D2AEA385841C Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1723671219; cv=none; b=bAaF9i+4rl1eQ9SJimamdfZbvXi9QVsVcgCkpLTlxJAeEt/38wf9Tw35fzbucZyGrNQpDHVzsMmkFqlAQCamfau61FkAueaT1sqEISCb8m5vc73tsnlOdq2g32zJcSmjfhYVJehfK7zWPmrN1qgtZ3yKEZdLx9z/6x0pZXaRnXk= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1723671219; c=relaxed/simple; bh=yx4V7jiAn3N/HqOodhTU3d3LkKcZ/I4lGkd5p5mIsV0=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=hAJrRwQmbPkbI6sLpGcTobDsg3lLuM2zGLpDIkwvPXDhP7YCCAxmNagA/CqqadWU0QCf23eV3UT6hP/+IGM/6ukWRj/zbmkanmMT0O6n1UplS+mdCIAkusD/pNXVFmFCF7Ch0N0w9prL64bDfHPmd3TQ00Puh1a5TgsrA8lG0MY= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1723671215; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=fM65dQu1bdet8xZfLClqeBVN7xVhu0ab38eexddJeJg=; b=dUETjw0iXV2iqssapqP/G0q61G9/I86cyCodoZz2ObhXEu6wyTOvnInLr7qvV8LO5XrvAb EM9m8qimWXhx2KC3w9R+IJiPORnpCPi0mPW+YlsOFBbjjSwVYx6LWKi+BWjdJ6znBubLK7 fLytsAnHrrWM3dkj6B6YxfZMIVXiems= Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-83-W6k1OMjLP6GtzybHUiC59w-1; Wed, 14 Aug 2024 17:33:34 -0400 X-MC-Unique: W6k1OMjLP6GtzybHUiC59w-1 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 9E09E195609E for ; Wed, 14 Aug 2024 21:33:33 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.22.8.64]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id D7E0219560A3; Wed, 14 Aug 2024 21:33:32 +0000 (UTC) From: Aaron Merey To: elfutils-devel@sourceware.org Cc: Aaron Merey Subject: [PATCH 9/9] doc: Add elf32_xlatetom.3 and elf64_xlatetom.3 Date: Wed, 14 Aug 2024 17:33:21 -0400 Message-ID: <20240814213321.244089-9-amerey@redhat.com> In-Reply-To: <20240814213321.244089-1-amerey@redhat.com> References: <20240814213321.244089-1-amerey@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.5 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_NUMSUBJECT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: elfutils-devel@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Elfutils-devel mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: elfutils-devel-bounces~patchwork=sourceware.org@sourceware.org Signed-off-by: Aaron Merey --- 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 --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 + +.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 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 + +.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 or https://sourceware.org/bugzilla/.