* [PATCH proxmox] oci: update doc comment of parse_and_extract_image
@ 2026-10-13 8:28 Filip Schauer
2026-10-22 11:22 ` applied: " Wolfgang Bumiller
0 siblings, 1 reply; 2+ messages in thread
From: Filip Schauer @ 2026-10-13 8:28 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>
---
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<P: AsRef<Path>>(
oci_tar_path: P,
rootfs_path: P,
--
2.47.3
^ permalink raw reply related [flat|nested] 2+ messages in thread
* applied: [PATCH proxmox] oci: update doc comment of parse_and_extract_image
2026-10-13 8:28 [PATCH proxmox] oci: update doc comment of parse_and_extract_image Filip Schauer
@ 2026-10-22 11:22 ` Wolfgang Bumiller
0 siblings, 0 replies; 2+ messages in thread
From: Wolfgang Bumiller @ 2026-10-22 11:22 UTC (permalink / raw)
To: Filip Schauer; +Cc: pve-devel
applied, thanks
On Tue, Oct 13, 2026 at 10:28:24AM +0200, Filip Schauer wrote:
> 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>
> ---
> 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<P: AsRef<Path>>(
> oci_tar_path: P,
> rootfs_path: P,
> --
> 2.47.3
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-10-22 11:22 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-10-13 8:28 [PATCH proxmox] oci: update doc comment of parse_and_extract_image Filip Schauer
2026-10-22 11:22 ` applied: " Wolfgang Bumiller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox