all lists on lists.proxmox.com
 help / color / mirror / Atom feed
* [PATCH] oci: update doc comment of parse_and_extract_image
@ 2026-11-03 14:45 Filip Schauer
  2026-11-03 14:47 ` [PATCH perl-rs] " Filip Schauer
  0 siblings, 1 reply; 2+ messages in thread
From: Filip Schauer @ 2026-11-03 14:45 UTC (permalink / raw)
  To: pve-devel

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





^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-11-03 14:47 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-03 14:45 [PATCH] oci: update doc comment of parse_and_extract_image Filip Schauer
2026-11-03 14:47 ` [PATCH perl-rs] " Filip Schauer

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