X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=src%2FREADME;h=1fd4be32bf85989047773a0186bdd63044de9abf;hp=8aa2348a1f93579657ec6cdf54d16dbfd3efe51f;hb=90d14bc151e488972d33eefaac2242d9a6e07578;hpb=3e9ed9c0fe49c3d4e4a8e467d521f676769c485a diff --git a/src/README b/src/README index 8aa2348..1fd4be3 100644 --- a/src/README +++ b/src/README @@ -5,19 +5,37 @@ 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. + + collect.mli, collect.ml + + Stats information is collected in these functions. + + screen.mli, screen.ml + + Various useful functions for drawing to the curses screen. + + redraw.mli, redraw.ml - The two interesting functions are called 'collect' and 'redraw'. + Redraw the main display. - 'collect' collects all the information about domains, etc. + csv_output.mli, csv_output.ml - 'redraw' updates the display on each frame. + Functions which implement --csv mode. + + stream_output.mli, stream_output.ml + + Functions which implement --stream mode. + + top.mli, top.ml + + This is the virt-top program. - Another interesting function is 'start_up' which handles all - start-up stuff, eg. command line arguments, connecting to the - hypervisor, enabling curses. + '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. @@ -38,7 +56,7 @@ The code is structured into these files: opt_csv.ml Any code which needs the optional ocaml-csv library goes - in here. This implements the --csv command line option. + in here. opt_calendar.ml