Remove dependency on xml-light, replace with libxml2

[virt-top.git] / src / README

diff --git a/src/README b/src/README
index 8aa2348..e49fd48 100644 (file)
--- a/src/README
+++ b/src/README
@@ -5,40 +5,45 @@ The code is structured into these files:
     String functions and other small utility functions.  This is
     included directly into virt_top.ml.
 
-  top.mli, top.ml
+  types.mli, types.ml
 
-    This is the virt-top program.
+    Various internally used types and functions operating on those
+    types.
 
-    The two interesting functions are called 'collect' and 'redraw'.
+  collect.mli, collect.ml
 
-    'collect' collects all the information about domains, etc.
+    Stats information is collected in these functions.
 
-    'redraw' updates the display on each frame.
+  screen.mli, screen.ml
 
-    Another interesting function is 'start_up' which handles all
-    start-up stuff, eg. command line arguments, connecting to the
-    hypervisor, enabling curses.
+    Various useful functions for drawing to the curses screen.
 
-    The function 'main_loop' runs the main loop and has sub-functions
-    to deal with keypresses, help screens and so on.
+  redraw.mli, redraw.ml
 
-  opt_gettext.ml
-    A generated file which adds gettext support if ocaml-gettext
-    was found at configure time, or else stubs it out.
+    Redraw the main display.
 
-  opt_xml.ml
+  csv_output.mli, csv_output.ml
 
-    Any code which needs the optional xml-light library goes
-    in here.  Mainly for parsing domain XML descriptions to get
-    the list of block devices and network interfaces.
+    Functions which implement --csv mode.
 
-    The reason for having it in a separate file is so that we
-    don't depend on xml-light.
+  stream_output.mli, stream_output.ml
 
-  opt_csv.ml
+    Functions which implement --stream mode.
 
-    Any code which needs the optional ocaml-csv library goes
-    in here.  This implements the --csv command line option.
+  top.mli, top.ml
+
+    This is the virt-top program.
+
+    'start_up' handles all start-up stuff, eg. command line arguments,
+    connecting to the hypervisor, enabling curses.
+
+    The function 'main_loop' runs the main loop and has sub-functions
+    to deal with keypresses, help screens and so on.
+
+  opt_gettext.ml
+
+    A generated file which adds gettext support if ocaml-gettext
+    was found at configure time, or else stubs it out.
 
   opt_calendar.ml
 
@@ -49,7 +54,7 @@ The code is structured into these files:
   main.ml
 
     This is just a small bit of code to glue the modules together
-    Top + Opt_xml? + Opt_csv? + Opt_calendar?
+    Top + Opt_calendar?
 
 The man-page is generated from the single file: