From 9a4ffbf427c8a9d0956a277c50b307f997cb046c Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Tue, 20 Oct 2015 22:31:41 -0500 Subject: [PATCH] doc: note that data integrity is not guaranteed in --unsafe-compact mode --- doc/man1/wimlib-imagex-capture.1 | 12 ++++++------ doc/man1/wimlib-imagex-export.1 | 13 +++++++------ doc/man1/wimlib-imagex-update.1 | 11 ++++++----- 3 files changed, 19 insertions(+), 17 deletions(-) diff --git a/doc/man1/wimlib-imagex-capture.1 b/doc/man1/wimlib-imagex-capture.1 index 6fc180b1..3413075b 100644 --- a/doc/man1/wimlib-imagex-capture.1 +++ b/doc/man1/wimlib-imagex-capture.1 @@ -565,12 +565,12 @@ See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). .SH NOTES \fBwimlib-imagex append\fR does not support appending an image to a split WIM. .PP -It is safe to abort an \fBwimlib-imagex append\fR command partway through; -however, after doing this, it is recommended to run \fBwimlib-imagex -optimize\fR to remove any data that was appended to the physical WIM file but -not yet incorporated into the structure of the WIM, unless the WIM was being -fully rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the -temporary file left over. +Except when using \fB--unsafe-compact\fR, it is safe to abort a \fBwimlib-imagex +append\fR command partway through; however, after doing this, it is recommended +to run \fBwimlib-imagex optimize\fR to remove any data that was appended to the +physical WIM file but not yet incorporated into the structure of the WIM, unless +the WIM was being fully rebuilt (e.g. with \fB--rebuild\fR), in which case you +should delete the temporary file left over. .PP \fBwimlib-imagex\fR creates WIMs compatible with Microsoft's software (WIMGAPI, ImageX, DISM), with some caveats: diff --git a/doc/man1/wimlib-imagex-export.1 b/doc/man1/wimlib-imagex-export.1 index c09dabee..4c5430a4 100644 --- a/doc/man1/wimlib-imagex-export.1 +++ b/doc/man1/wimlib-imagex-export.1 @@ -159,12 +159,13 @@ To export the first image of this split WIM to a new or existing WIM file wimlib-imagex export mywim.swm 1 other.wim --ref="mywim*.swm" .RE .SH NOTES -\fIData integrity\fR: It is safe to abort a \fBwimlib-imagex export\fR command partway through. -However, after doing this, it is recommended to run \fBwimlib-imagex -optimize\fR on the destination WIM to remove any data that was appended to the -physical WIM file but not yet incorporated into the structure of the WIM, unless -the WIM was being rebuilt (e.g. with \fB--rebuild\fR), in which case you should -delete the temporary file left over. +\fIData integrity\fR: Except when using \fB--unsafe-compact\fR, it is safe to +abort a \fBwimlib-imagex export\fR command partway through. However, after +doing this, it is recommended to run \fBwimlib-imagex optimize\fR on the +destination WIM to remove any data that was appended to the physical WIM file +but not yet incorporated into the structure of the WIM, unless the WIM was being +rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the +temporary file left over. .PP \fISingle instancing\fR: The WIM format uses single-instance streams (roughly, "files"). When an image is exported, only the streams ("files") not already diff --git a/doc/man1/wimlib-imagex-update.1 b/doc/man1/wimlib-imagex-update.1 index 73f52027..ff9f0f4b 100644 --- a/doc/man1/wimlib-imagex-update.1 +++ b/doc/man1/wimlib-imagex-update.1 @@ -198,11 +198,12 @@ On UNIX-like systems, you cannot use \fBwimlib-imagex update\fR to add files to an image directly from an NTFS volume using libntfs-3g, even though \fBwimlib-imagex capture\fR supports capturing a full image this way. .PP -It is safe to abort an \fBwimlib-imagex update\fR command partway through; -however, after doing this, it is recommended to run \fBwimlib-imagex -optimize\fR to remove any data that was appended to the physical WIM file but -not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was -specified, in which case you should delete the temporary file left over. +Except when using \fB--unsafe-compact\fR, it is safe to abort a \fBwimlib-imagex +update\fR command partway through; however, after doing this, it is recommended +to run \fBwimlib-imagex optimize\fR to remove any data that was appended to the +physical WIM file but not yet incorporated into the structure of the WIM, unless +\fB--rebuild\fR was specified, in which case you should delete the temporary +file left over. .SH EXAMPLES All the examples below show the update command file to be created as well as the \fBwimlib-imagex update\fR command to run to perform the updates. -- 2.43.0