X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=generator%2Fgenerator_types.ml;h=50e960405000a16005d3b9cf3b68c1f3494a2cf6;hp=be9a1956f36f1e55c4a4f964cc0366377eb0412b;hb=84763d7fca3668c62ee3fe53d0e00a5a672f687b;hpb=17233ce2113aa730752ae3420cc209b2a72ab616

diff --git a/generator/generator_types.ml b/generator/generator_types.ml
index be9a195..50e9604 100644
--- a/generator/generator_types.ml
+++ b/generator/generator_types.ml
@@ -1,5 +1,5 @@
 (* libguestfs
- * Copyright (C) 2009-2010 Red Hat Inc.
+ * Copyright (C) 2009-2011 Red Hat Inc.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -203,6 +203,8 @@ and argt =
      *)
   | Pointer of (string * string)
 
+type errcode = [ `CannotReturnError | `ErrorIsMinusOne | `ErrorIsNULL ]
+
 type flags =
   | ProtocolLimitWarning  (* display warning about protocol size limits *)
   | DangerWillRobinson	  (* flags particularly dangerous commands *)
@@ -218,7 +220,7 @@ and fish_output_t =
   | FishOutputOctal       (* for int return, print in octal *)
   | FishOutputHexadecimal (* for int return, print in hex *)
 
-(* See section "Tests" in HACKING file. *)
+(* See guestfs(3)/EXTENDING LIBGUESTFS. *)
 type tests = (test_init * test_prereq * test) list
 and test =
     (* Run the command sequence and just expect nothing to fail. *)
@@ -334,15 +336,16 @@ and test_init =
   | InitEmpty
 
     (* /dev/sda contains a single partition /dev/sda1, with random
-     * content.  /dev/sdb and /dev/sdc may have random content.
-     * No LVM.
+     * content.  No LVM.
      *)
   | InitPartition
 
     (* /dev/sda contains a single partition /dev/sda1, which is formatted
      * as ext2, empty [except for lost+found] and mounted on /.
-     * /dev/sdb and /dev/sdc may have random content.
      * No LVM.
+     *
+     * Note: for testing filesystem operations, it is quicker to use
+     * InitScratchFS
      *)
   | InitBasicFS
 
@@ -350,7 +353,9 @@ and test_init =
      *   /dev/sda1 (is a PV):
      *     /dev/VG/LV (size 8MB):
      *       formatted as ext2, empty [except for lost+found], mounted on /
-     * /dev/sdb and /dev/sdc may have random content.
+     *
+     * Note: only use this if you really need a freshly created filesystem
+     * on LVM.  Normally you should use InitScratchFS instead.
      *)
   | InitBasicFSonLVM
 
@@ -359,6 +364,16 @@ and test_init =
      *)
   | InitISOFS
 
+    (* /dev/sdb1 (write scratch disk) is mounted on /.  The filesystem
+     * will be empty.
+     *
+     * Note that this filesystem is not recreated between tests, and
+     * could contain random files and directories from previous tests.
+     * Therefore it is recommended that you create uniquely named files
+     * and directories for your tests.
+     *)
+  | InitScratchFS
+
 (* Sequence of commands for testing. *)
 and seq = cmd list
 and cmd = string list