Associate opaque plugin ID with each major structure.
[virt-df.git] / lib / README
index 6ee34fc..602df03 100644 (file)
@@ -18,7 +18,13 @@ what is going on inside the source.
 
 The main program consists of two modules:
 
- - diskimage.ml / diskimage.mli (module name: Diskimage)
+ - diskimage.ml / diskimage.mli
+
+   This is the library.  It loads the domain descriptions, calls out
+   to the plug-ins to probe for disks / partitions / filesystems /
+   etc., and finally returns the results.
+
+ - diskimage_utils.ml / diskimage_utils.mli (module name: Diskimage_utils)
 
    This has evolved into a library of miscellaneous functions
    and values which are included throughout the rest of the
@@ -28,16 +34,6 @@ The main program consists of two modules:
    Start by reading diskimage.mli which contains the full types
    and plenty of documentation.
 
- - diskimage_main.ml
-
-   This is the program.  It reads the command line arguments,
-   loads the domain descriptions, calls out to the plug-ins
-   to probe for disks / partitions / filesystems / etc., and
-   finally prints the results.
-
-   The file consists of basically one large program that
-   does all of the above in sequence.
-
 Everything else in this directory is a plug-in specialized for probing
 a particular filesystem, partition scheme or type of LVM.  The
 plug-ins at time of writing are: