From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 3DBC01FF0AE for ; Tue, 13 Oct 2026 10:28:41 +0200 (CEST) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 0E54021325; Tue, 13 Oct 2026 10:28:37 +0200 (CEST) From: Filip Schauer To: pve-devel@lists.proxmox.com Subject: [PATCH proxmox] oci: update doc comment of parse_and_extract_image Date: Tue, 13 Oct 2026 10:28:24 +0200 Message-ID: <20261013082826.27056-1-f.schauer@proxmox.com> X-Mailer: git-send-email 2.47.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1791880111591 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.463 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: VMTNGLRBTCV5A3GDE465ZRCWBPRLTG7B X-Message-ID-Hash: VMTNGLRBTCV5A3GDE465ZRCWBPRLTG7B X-MailFrom: f.schauer@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: The function does not return the entire image config, only the optional execution parameters contained in the image config. Signed-off-by: Filip Schauer --- proxmox-oci/src/lib.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/proxmox-oci/src/lib.rs b/proxmox-oci/src/lib.rs index 9ef16d41..b274e46a 100644 --- a/proxmox-oci/src/lib.rs +++ b/proxmox-oci/src/lib.rs @@ -101,7 +101,7 @@ pub enum ProxmoxOciError { ExtractError(#[from] ExtractError), } -/// Extract the rootfs of an OCI image tar and return the image config. +/// Extract the rootfs of an OCI image tar and return its execution parameters. /// /// # Arguments /// @@ -109,6 +109,11 @@ pub enum ProxmoxOciError { /// * `rootfs_path` - Destination path where the rootfs will be extracted to /// * `arch` - Optional CPU architecture used to pick the first matching manifest from a multi-arch /// image index. If `None`, the first manifest will be used. +/// +/// # Returns +/// +/// On success, this returns the optional container execution parameters +/// if present in the image configuration. pub fn parse_and_extract_image>( oci_tar_path: P, rootfs_path: P, -- 2.47.3