X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=lib%2FREADME;h=2886d35c1a065826505ff4762118d7909244cb9d;hb=HEAD;hp=6ee34fc1c60d73a2e118f4d66b0ceaba2008f674;hpb=9611aba66734efe3e2f1e0792a90003b657a89f5;p=virt-df.git diff --git a/lib/README b/lib/README index 6ee34fc..2886d35 100644 --- a/lib/README +++ b/lib/README @@ -9,8 +9,8 @@ Developer documentation This subdirectory contains a library of useful functions for parsing disk images. -It is all based on and uses the pa_bitmatch syntax extension & -library. You need pa_bitmatch >= 0.5. +It is all based on and uses the pa_bitstring syntax extension & +library. You need pa_bitstring >= 1.9.7. This program has suddenly become rather large and confusing. Hopefully this documentation should go some way towards explaining @@ -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: