summaryrefslogtreecommitdiffstats
path: root/java
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-04-30 19:32:58 +0100
committerRichard Jones <rjones@redhat.com>2009-04-30 19:32:58 +0100
commit36f9dac1a2530b575dab9226f6ddd85e6e8c8590 (patch)
tree46f63296579bc87d9cebb917c555a58fe9238f9b /java
parent62df226f26bd6ac3c481a7790eb89d760d2f0386 (diff)
downloadlibguestfs-36f9dac1a2530b575dab9226f6ddd85e6e8c8590.tar.gz
libguestfs-36f9dac1a2530b575dab9226f6ddd85e6e8c8590.tar.xz
libguestfs-36f9dac1a2530b575dab9226f6ddd85e6e8c8590.zip
Added notes to the 'fsck' command documentation.
Diffstat (limited to 'java')
-rw-r--r--java/com/redhat/et/libguestfs/GuestFS.java19
1 files changed, 14 insertions, 5 deletions
diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java
index 293ee23e..5b816238 100644
--- 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
*/