all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Filip Schauer <f.schauer@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH] oci: update doc comment of parse_and_extract_image
Date: Tue,  3 Nov 2026 15:45:45 +0100	[thread overview]
Message-ID: <20261103144546.271947-1-f.schauer@proxmox.com> (raw)

The function does not return the entire image config, only the optional
execution parameters contained in the image config.

Signed-off-by: Filip Schauer <f.schauer@proxmox.com>
---
This is the same thing as 9b5bf494b175 in proxmox.git.

 pve-rs/src/bindings/oci.rs | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/pve-rs/src/bindings/oci.rs b/pve-rs/src/bindings/oci.rs
index 7f5acaf..30e74fd 100644
--- a/pve-rs/src/bindings/oci.rs
+++ b/pve-rs/src/bindings/oci.rs
@@ -7,7 +7,7 @@ pub mod pve_rs_oci {
     use anyhow::Error;
     use proxmox_oci::Config;
 
-    /// 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
     ///
@@ -15,6 +15,11 @@ pub mod pve_rs_oci {
     /// * `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.
     #[export]
     pub fn parse_and_extract_image(
         oci_tar_path: &str,
-- 
2.47.3





             reply	other threads:[~2026-11-03 14:45 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-03 14:45 Filip Schauer [this message]
2026-11-03 14:47 ` [PATCH perl-rs] oci: update doc comment of parse_and_extract_image Filip Schauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261103144546.271947-1-f.schauer@proxmox.com \
    --to=f.schauer@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal