Clarify sparse behaviour of truncate-size command.
authorRichard Jones <rjones@redhat.com>
Thu, 27 May 2010 09:25:18 +0000 (10:25 +0100)
committerRichard Jones <rjones@redhat.com>
Wed, 2 Jun 2010 18:35:40 +0000 (19:35 +0100)
(cherry picked from commit d12a702fe1898f3ea421210d92c705440efe07a8)

src/generator.ml

index 861ad36..7744766 100755 (executable)
@@ -3911,8 +3911,13 @@ file must exist already.");
    "truncate a file to a particular size",
    "\
 This command truncates C<path> to size C<size> bytes.  The file
-must exist already.  If the file is smaller than C<size> then
-the file is extended to the required size with null bytes.");
+must exist already.
+
+If the current file size is less than C<size> then
+the file is extended to the required size with zero bytes.
+This creates a sparse file (ie. disk blocks are not allocated
+for the file until you write to it).  To create a non-sparse
+file of zeroes, use C<guestfs_fallocate64> instead.");
 
   ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
    [InitBasicFS, Always, TestOutputStruct (