HACKING file, update (C) messages.
authorRichard Jones <rjones@trick.home.annexia.org>
Tue, 6 Oct 2009 15:38:11 +0000 (16:38 +0100)
committerRichard Jones <rjones@trick.home.annexia.org>
Tue, 6 Oct 2009 15:38:11 +0000 (16:38 +0100)
15 files changed:
HACKING [moved from virt-top/README with 62% similarity, mode: 0644]
Make.rules.in
Makefile.in
README
virt-top/Makefile.in
virt-top/virt_top.ml
virt-top/virt_top.mli
virt-top/virt_top_calendar1.ml
virt-top/virt_top_calendar2.ml
virt-top/virt_top_csv.ml
virt-top/virt_top_main.ml
virt-top/virt_top_utils.ml
virt-top/virt_top_utils.mli
virt-top/virt_top_version.ml.in
virt-top/virt_top_xml.ml

old mode 100755 (executable)
new mode 100644 (file)
similarity index 62%
rename from virt-top/README
rename to HACKING
index b594f95..bce40a9
+++ 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:
 
index a25d485..35af848 100644 (file)
@@ -1,5 +1,5 @@
 # ocaml-libvirt
-# Copyright (C) 2007 Red Hat Inc., Richard W.M. Jones
+# Copyright (C) 2007-2009 Red Hat Inc., Richard W.M. Jones
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
index c9a6786..ef2eadc 100644 (file)
@@ -1,5 +1,5 @@
 # virt-top
-# Copyright (C) 2007-2008 Red Hat Inc., Richard W.M. Jones
+# Copyright (C) 2007-2009 Red Hat Inc., Richard W.M. Jones
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
diff --git a/README b/README
index fc20808..0e56218 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 virt-top
 ----------------------------------------------------------------------
 
-Copyright (C) 2007-2008 Richard W.M. Jones, Red Hat Inc.
+Copyright (C) 2007-2009 Richard W.M. Jones, Red Hat Inc.
 http://et.redhat.com/~rjones/virt-top/
 http://libvirt.org/ocaml/
 http://libvirt.org/
index 6a782cb..34f1ad6 100755 (executable)
@@ -1,5 +1,5 @@
 # virt-top
-# Copyright (C) 2007 Red Hat Inc., Richard W.M. Jones
+# Copyright (C) 2007-2009 Red Hat Inc., Richard W.M. Jones
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
index 4fb7b47..36b7e17 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 790eb31..efa5f56 100755 (executable)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 779e62b..beac4ee 100755 (executable)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 3d042e3..184f2b9 100755 (executable)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 3393e3a..e048856 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 4ab60ad..4e1c5b7 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 69f442f..f858e0e 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 5af26d4..5b71b31 100755 (executable)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 12d72fb..eaa1df1 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify
index 73a4906..ab291d3 100644 (file)
@@ -1,5 +1,5 @@
 (* 'top'-like tool for libvirt domains.
-   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   (C) Copyright 2007-2009 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
 
    This program is free software; you can redistribute it and/or modify