Added notes to the 'fsck' command documentation.

diff --git a/fish/cmds.c b/fish/cmds.c
index c23da2f..142b595 100644 (file)
--- a/fish/cmds.c
+++ b/fish/cmds.c
@@ -443,7 +443,7 @@ void display_command (const char *cmd)
     pod2text ("get-e2uuid - get the ext2/3/4 filesystem UUID", " get-e2uuid <device>\n\nThis returns the ext2/3/4 filesystem UUID of the filesystem on\nC<device>.");
   else
   if (strcasecmp (cmd, "fsck") == 0)
     pod2text ("get-e2uuid - get the ext2/3/4 filesystem UUID", " get-e2uuid <device>\n\nThis returns the ext2/3/4 filesystem UUID of the filesystem on\nC<device>.");
   else
   if (strcasecmp (cmd, "fsck") == 0)

-    pod2text ("fsck - run the filesystem checker", " fsck <fstype> <device>\n\nThis runs the filesystem checker (fsck) on C<device> which\nshould have filesystem type C<fstype>.\n\nThe returned integer is the status.  See L<fsck(8)> for the\nlist of status codes from C<fsck>, and note that multiple\nstatus codes can be summed together.\n\nIt is entirely equivalent to running C<fsck -a -t fstype device>.\nNote that checking or repairing NTFS volumes is not supported\n(by linux-ntfs).");
+    pod2text ("fsck - run the filesystem checker", " fsck <fstype> <device>\n\nThis runs the filesystem checker (fsck) on C<device> which\nshould have filesystem type C<fstype>.\n\nThe returned integer is the status.  See L<fsck(8)> for the\nlist of status codes from C<fsck>.\n\nNotes:\n\n=over 4\n\n=item *\n\nMultiple status codes can be summed together.\n\n=item *\n\nA non-zero return code can mean \"success\", for example if\nerrors have been corrected on the filesystem.\n\n=item *\n\nChecking or repairing NTFS volumes is not supported\n(by linux-ntfs).\n\n=back\n\nThis command is entirely equivalent to running C<fsck -a -t fstype device>.");

   else
   if (strcasecmp (cmd, "zero") == 0)
     pod2text ("zero - write zeroes to the device", " zero <device>\n\nThis command writes zeroes over the first few blocks of C<device>.\n\nHow many blocks are zeroed isn't specified (but it's I<not> enough\nto securely wipe the device).  It should be sufficient to remove\nany partition tables, filesystem superblocks and so on.");
   else
   if (strcasecmp (cmd, "zero") == 0)
     pod2text ("zero - write zeroes to the device", " zero <device>\n\nThis command writes zeroes over the first few blocks of C<device>.\n\nHow many blocks are zeroed isn't specified (but it's I<not> enough\nto securely wipe the device).  It should be sufficient to remove\nany partition tables, filesystem superblocks and so on.");

diff --git a/guestfish-actions.pod b/guestfish-actions.pod
index d391257..44d86f2 100644 (file)
--- a/guestfish-actions.pod
+++ b/guestfish-actions.pod
@@ -457,13 +457,30 @@ This runs the filesystem checker (fsck) on C<device> which
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the

-list of status codes from C<fsck>, and note that multiple
-status codes can be summed together.
+list of status codes from C<fsck>.

 
 

-It is entirely equivalent to running C<fsck -a -t fstype device>.
-Note that checking or repairing NTFS volumes is not supported
+Notes:
+
+=over 4
+
+=item *
+
+Multiple status codes can be summed together.
+
+=item *
+
+A non-zero return code can mean "success", for example if
+errors have been corrected on the filesystem.
+
+=item *
+
+Checking or repairing NTFS volumes is not supported

 (by linux-ntfs).
 
 (by linux-ntfs).
 

+=back
+
+This command is entirely equivalent to running C<fsck -a -t fstype device>.
+

 =head2 get-autosync
 
  get-autosync
 =head2 get-autosync
 
  get-autosync

diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index fb7c3db..6fc51f0 100644 (file)
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -592,13 +592,30 @@ This runs the filesystem checker (fsck) on C<device> which
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the

-list of status codes from C<fsck>, and note that multiple
-status codes can be summed together.
+list of status codes from C<fsck>.

 
 

-It is entirely equivalent to running C<fsck -a -t fstype device>.
-Note that checking or repairing NTFS volumes is not supported
+Notes:
+
+=over 4
+
+=item *
+
+Multiple status codes can be summed together.
+
+=item *
+
+A non-zero return code can mean "success", for example if
+errors have been corrected on the filesystem.
+
+=item *
+
+Checking or repairing NTFS volumes is not supported

 (by linux-ntfs).
 
 (by linux-ntfs).
 

+=back
+
+This command is entirely equivalent to running C<fsck -a -t fstype device>.
+

 On error this function returns -1.
 
 =head2 guestfs_get_autosync
 On error this function returns -1.
 
 =head2 guestfs_get_autosync

diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index 293ee23..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
    * 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
    */
    * 
    * @throws LibGuestFSException
    */

diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm
index 2d75b69..bab7887 100644 (file)
--- a/perl/lib/Sys/Guestfs.pm
+++ b/perl/lib/Sys/Guestfs.pm
@@ -474,13 +474,30 @@ This runs the filesystem checker (fsck) on C<device> which
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the

-list of status codes from C<fsck>, and note that multiple
-status codes can be summed together.
+list of status codes from C<fsck>.

 
 

-It is entirely equivalent to running C<fsck -a -t fstype device>.
-Note that checking or repairing NTFS volumes is not supported
+Notes:
+
+=over 4
+
+=item *
+
+Multiple status codes can be summed together.
+
+=item *
+
+A non-zero return code can mean "success", for example if
+errors have been corrected on the filesystem.
+
+=item *
+
+Checking or repairing NTFS volumes is not supported

 (by linux-ntfs).
 
 (by linux-ntfs).
 

+=back
+
+This command is entirely equivalent to running C<fsck -a -t fstype device>.
+

 =item $autosync = $h->get_autosync ();
 
 Get the autosync flag.
 =item $autosync = $h->get_autosync ();
 
 Get the autosync flag.

diff --git a/python/guestfs.py b/python/guestfs.py
index 3cfc86a..022150b 100644 (file)
--- a/python/guestfs.py
+++ b/python/guestfs.py
@@ -1154,12 +1154,21 @@ class GuestFS:
         which should have filesystem type "fstype".
         
         The returned integer is the status. See fsck(8) for the
         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)
 
         """
         return libguestfsmod.fsck (self._o, fstype, device)
 

diff --git a/src/generator.ml b/src/generator.ml
index 8d5450d..04445ee 100755 (executable)
--- a/src/generator.ml
+++ b/src/generator.ml
@@ -1646,12 +1646,29 @@ This runs the filesystem checker (fsck) on C<device> which
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the
 should have filesystem type C<fstype>.
 
 The returned integer is the status.  See L<fsck(8)> for the

-list of status codes from C<fsck>, and note that multiple
-status codes can be summed together.
+list of status codes from C<fsck>.

 
 

-It is entirely equivalent to running C<fsck -a -t fstype device>.
-Note that checking or repairing NTFS volumes is not supported
-(by linux-ntfs).");
+Notes:
+
+=over 4
+
+=item *
+
+Multiple status codes can be summed together.
+
+=item *
+
+A non-zero return code can mean \"success\", for example if
+errors have been corrected on the filesystem.
+
+=item *
+
+Checking or repairing NTFS volumes is not supported
+(by linux-ntfs).
+
+=back
+
+This command is entirely equivalent to running C<fsck -a -t fstype device>.");

 
   ("zero", (RErr, [String "device"]), 85, [],
    [InitBasicFS, TestOutput (
 
   ("zero", (RErr, [String "device"]), 85, [],
    [InitBasicFS, TestOutput (