- * rebuild: the new WIM is written to a temporary file and then renamed to the
- * original file after it is has been completely written. The temporary file
- * currently is made in the same directory as the original WIM file. A full
- * rebuild may take a while, but can be used even if images have been modified
- * or deleted, will produce a WIM with no holes, and has little chance of
- * unintentional data loss because the temporary WIM is fsync()ed before being
- * renamed to the original WIM.
- *
- * The second way to overwrite a WIM is by appending to the end of it. This can
- * be much faster than a full rebuild, but it only works if the only operations
- * on the WIM have been to change the header or XML data, or to add new images.
- * Writing a WIM in this mode begins with writing any new file resources *after*
- * everything in the old WIM, even though this will leave a hole where the old
- * lookup table, XML data, and integrity were. This is done so that the WIM
- * remains valid even if the operation is aborted mid-write.
- *
- * By default, the overwrite mode is chosen based on the past operations
- * performed on the WIM. Use the flag ::WIMLIB_WRITE_FLAG_REBUILD to explicitly
- * request a full rebuild.
+ * rebuild. In this mode, the new WIM is written to a temporary file and then
+ * renamed to the original file after it is has been completely written. The
+ * temporary file is made in the same directory as the original WIM file. A
+ * full rebuild may take a while, but can be used even if images have been
+ * modified or deleted, will produce a WIM with no holes, and has little chance
+ * of unintentional data loss because the temporary WIM is fsync()ed before
+ * being renamed to the original WIM.
+ *
+ * The second way to overwrite a WIM is by appending to the end of it and
+ * overwriting the header. This can be much faster than a full rebuild, but it
+ * only works if the only operations on the WIM have been to change the header
+ * and/or XML data, or to add new images. Writing a WIM in this mode begins
+ * with writing any new file resources *after* everything in the old WIM, even
+ * though this will leave a hole where the old lookup table, XML data, and
+ * integrity were. This is done so that the WIM remains valid even if the
+ * operation is aborted mid-write. The WIM header is only overwritten at the
+ * very last moment, and up until that point the WIM will be seen as the old
+ * version.
+ *
+ * By default, the overwrite mode is determine automatically based on the past
+ * operations performed on the ::WIMStruct. Use the flag
+ * ::WIMLIB_WRITE_FLAG_REBUILD to explicitly request a full rebuild, and use the
+ * ::WIMLIB_WRITE_FLAG_SOFT_DELETE to request the in-place overwrite even if
+ * images have been deleted from the WIM.