Added notes to the 'fsck' command documentation.
[libguestfs.git] / python / guestfs.py
index 37dce2b..022150b 100644 (file)
@@ -1154,12 +1154,32 @@ class GuestFS:
         which should have filesystem type "fstype".
         
         The returned integer is the status. See fsck(8) for the
-        list of status codes from "fsck", and note that multiple
-        status codes can be summed together.
+        list of status codes from "fsck".
         
-        It is entirely equivalent to running "fsck -a -t fstype
-        device". Note that checking or repairing NTFS volumes is
-        not supported (by linux-ntfs).
+        Notes:
+        
+        *   Multiple status codes can be summed together.
+        
+        *   A non-zero return code can mean "success", for
+        example if errors have been corrected on the
+        filesystem.
+        
+        *   Checking or repairing NTFS volumes is not supported
+        (by linux-ntfs).
+        
+        This command is entirely equivalent to running "fsck -a
+        -t fstype device".
         """
         return libguestfsmod.fsck (self._o, fstype, device)
 
+    def zero (self, device):
+        u"""This command writes zeroes over the first few blocks of
+        "device".
+        
+        How many blocks are zeroed isn't specified (but it's
+        *not* enough to securely wipe the device). It should be
+        sufficient to remove any partition tables, filesystem
+        superblocks and so on.
+        """
+        return libguestfsmod.zero (self._o, device)
+