From e7b91df46ffe99008ab10dc24826b9a009fd6048 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Ferr=C3=A3o?= <2031761+viniciusferrao@users.noreply.github.com> Date: Sat, 10 Oct 2026 01:43:07 -0300 Subject: [PATCH] docs(packimage): describe how packimage replaces the root image archive The man page said that packimage overwrites the root image and that nodes cannot use it while packimage runs. Describe the replacement instead, and the disk space that it needs. --- docs/source/guides/admin-guides/references/man1/packimage.1.rst | 2 +- xCAT-client/pods/man1/packimage.1.pod | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/packimage.1.rst b/docs/source/guides/admin-guides/references/man1/packimage.1.rst index 4c8568b15..29b625cb3 100644 --- a/docs/source/guides/admin-guides/references/man1/packimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/packimage.1.rst @@ -33,7 +33,7 @@ DESCRIPTION Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot. -Note: For an osimage that is deployed on a cluster, running \ **packimage**\ will overwrite the existing rootimage file and be unavailable to the compute nodes while \ **packimage**\ is running. +Note: \ **packimage**\ writes the new file next to the existing one and replaces it only when the new file is complete. Compute nodes can download the existing file while \ **packimage**\ runs, and the existing file stays if \ **packimage**\ fails. The image directory needs space for both files while \ **packimage**\ runs. ********** diff --git a/xCAT-client/pods/man1/packimage.1.pod b/xCAT-client/pods/man1/packimage.1.pod index 32e91d9f7..45dd1da69 100644 --- a/xCAT-client/pods/man1/packimage.1.pod +++ b/xCAT-client/pods/man1/packimage.1.pod @@ -14,7 +14,7 @@ B [B<-m>|B<--method> B] [B<-c>|B<--compress> B will overwrite the existing rootimage file and be unavailable to the compute nodes while B is running. +Note: B writes the new file next to the existing one and replaces it only when the new file is complete. Compute nodes can download the existing file while B runs, and the existing file stays if B fails. The image directory needs space for both files while B runs. =head1 PARAMETERS