Added notes to the 'fsck' command documentation.

[libguestfs.git] / java / com / redhat / et / libguestfs / GuestFS.java

diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index 844c3b3..5b81623 100644 (file)
--- a/java/com/redhat/et/libguestfs/GuestFS.java
+++ b/java/com/redhat/et/libguestfs/GuestFS.java
@@ -2363,12 +2363,21 @@ public 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".
    * 
    * @throws LibGuestFSException
    */
@@ -2382,4 +2391,27 @@ public class GuestFS {
   private native int _fsck (long g, String fstype, String device)
     throws LibGuestFSException;
 
+  /**
+   * write zeroes to the device
+   *
+   * 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.
+   * 
+   * @throws LibGuestFSException
+   */
+  public void zero (String device)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("zero: handle is closed");
+    _zero (g, device);
+  }
+  private native void _zero (long g, String device)
+    throws LibGuestFSException;
+
 }