HACKING file, update (C) messages.

[virt-top.git] / HACKING

diff --git a/virt-top/README b/HACKING
old mode 100755 (executable)
new mode 100644 (file)
similarity index 62%
rename from virt-top/README
rename to HACKING
index b594f95..bce40a9
--- a/virt-top/README
+++ b/HACKING
@@ -1,3 +1,16 @@
+This file contains some tips for hacking on this code.
+
+General OCaml advice:
+
+(1) The *.mli file describes the interface of the module.  It's a good
+    idea to look at this file first, then at *.ml (the implementation).
+
+(2) Emacs users: use tuareg-mode for editing OCaml.
+
+(3) http://www.ocaml-tutorial.org/
+
+(4) http://camltastic.blogspot.com/2008/08/3-things-that-will-confuse-you-when.html
+
 The code is structured into these files:
 
   virt_top_utils.mli / virt_top_utils.ml
@@ -5,6 +18,10 @@ The code is structured into these files:
     String functions and other small utility functions.  This is
     included directly into virt_top.ml.
 
+  virt_top_version.ml
+
+    The version number (automatically generated by configure).
+
   virt_top.mli / virt_top.ml
 
     This is the virt-top program.
@@ -36,16 +53,23 @@ The code is structured into these files:
     Any code which needs the optional ocaml-csv library goes
     in here.  This implements the --csv command line option.
 
-  virt_top_calendar.ml
+  virt_top_calendar1.ml
+  virt_top_calendar2.ml
 
     Any code which needs the optional ocaml-calendar library
     goes in here.  This implements the --end-time command line
-    option.
+    option.  Note there are two incompatible versions of the
+    ocaml-calendar library, which is why we have two
+    implementations.  The Makefile works out which one to use.
+
+  virt_top_gettext.ml
+
+    Gettext interaction (this is generated by ./configure).
 
   virt_top_main.ml
 
-    This is just a small bit of code to glue the modules together
-    Virt_top + Virt_top_xml? + Virt_top_csv? + Virt_top_calendar?
+    This is just a small bit of code to glue the modules above
+    together.
 
 The man-page is generated from the single file: