From 4e0e062e081fcbb6a660084308287926c52c9353 Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Wed, 24 Feb 2016 19:41:30 -0600 Subject: [PATCH 1/1] Briefly describe --unsafe-compact for each command --- doc/man1/wimlib-imagex-capture.1 | 6 +++++- doc/man1/wimlib-imagex-delete.1 | 5 ++++- doc/man1/wimlib-imagex-export.1 | 5 ++++- doc/man1/wimlib-imagex-update.1 | 5 ++++- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/man1/wimlib-imagex-capture.1 b/doc/man1/wimlib-imagex-capture.1 index c8fae949..6e35a314 100644 --- a/doc/man1/wimlib-imagex-capture.1 +++ b/doc/man1/wimlib-imagex-capture.1 @@ -579,7 +579,11 @@ default, set the configuration file to however, this may still be overridden through the \fB--config\fR parameter. .TP \fB--unsafe-compact\fR -See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). +For \fBwimlib-imagex append\fR: compact the WIM archive in-place and append any +new data, eliminating "holes". In general, this option should \fInot\fR be used +because a failed or interrupted compaction will corrupt the WIM archive. For +more information, see the documentation for this option in +\fBwimlib-imagex-optimize\fR (1). .TP \fB--snapshot\fR Create a temporary filesystem snapshot of the source directory and capture the diff --git a/doc/man1/wimlib-imagex-delete.1 b/doc/man1/wimlib-imagex-delete.1 index 4d063e3c..d72d9be8 100644 --- a/doc/man1/wimlib-imagex-delete.1 +++ b/doc/man1/wimlib-imagex-delete.1 @@ -46,7 +46,10 @@ You may use \fBwimlib-imagex optimize\fR to delete unreferenced streams from a W has had images soft-deleted from it. .TP \fB--unsafe-compact\fR -See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). +Compact the WIM archive in-place, eliminating "holes". In general, this option +should \fInot\fR be used because a failed or interrupted compaction will corrupt +the WIM archive. For more information, see the documentation for this option in +\fBwimlib-imagex-optimize\fR (1). .SH EXAMPLES Delete the first image from 'boot.wim': .RS diff --git a/doc/man1/wimlib-imagex-export.1 b/doc/man1/wimlib-imagex-export.1 index 67dcc2df..198b5044 100644 --- a/doc/man1/wimlib-imagex-export.1 +++ b/doc/man1/wimlib-imagex-export.1 @@ -134,7 +134,10 @@ archive, set the compression type to that recommended for WIMBoot (currently, XPRESS with 4096 byte chunks). .TP \fB--unsafe-compact\fR -See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). +Compact the WIM archive in-place and append any new data, eliminating "holes". +In general, this option should \fInot\fR be used because a failed or interrupted +compaction will corrupt the WIM archive. For more information, see the +documentation for this option in \fBwimlib-imagex-optimize\fR (1). .SH SPLIT WIMS You may use \fBwimlib-imagex export\fR to export images from a split WIM. The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM, diff --git a/doc/man1/wimlib-imagex-update.1 b/doc/man1/wimlib-imagex-update.1 index cc6dab9e..bb805490 100644 --- a/doc/man1/wimlib-imagex-update.1 +++ b/doc/man1/wimlib-imagex-update.1 @@ -165,7 +165,10 @@ boot process). See the documentation for the \fB--wimboot\fR option of \fBwimlib-imagex apply\fR (1) for more information. .TP \fB--unsafe-compact\fR -See the documentation for this option in \fBwimlib-imagex-optimize\fR (1). +Compact the WIM archive in-place and append any new data, eliminating "holes". +In general, this option should \fInot\fR be used because a failed or interrupted +compaction will corrupt the WIM archive. For more information, see the +documentation for this option in \fBwimlib-imagex-optimize\fR (1). .SH NOTES \fBwimlib-imagex update\fR is partly redundant with \fBwimlib-imagex mountrw\fR, since if a WIM image can be mounted read-write, then there -- 2.43.0