summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Jones <rjones@trick.home.annexia.org>2009-10-06 16:38:11 +0100
committerRichard Jones <rjones@trick.home.annexia.org>2009-10-06 16:38:11 +0100
commit2a8acd07005f2e8cdc43a6cc2a4e6f3d66f9fc4d (patch)
tree624db0958d105a340d22c9c59c3f39b8d6d8073f
parentec78262c21c9bb6ccfe52925471a58a2e360043c (diff)
downloadvirt-top-2a8acd07005f2e8cdc43a6cc2a4e6f3d66f9fc4d.tar.gz
virt-top-2a8acd07005f2e8cdc43a6cc2a4e6f3d66f9fc4d.tar.xz
virt-top-2a8acd07005f2e8cdc43a6cc2a4e6f3d66f9fc4d.zip
HACKING file, update (C) messages.
-rw-r--r--[-rwxr-xr-x]HACKING (renamed from virt-top/README)32
-rw-r--r--Make.rules.in2
-rw-r--r--Makefile.in2
-rw-r--r--README2
-rwxr-xr-xvirt-top/Makefile.in2
-rw-r--r--virt-top/virt_top.ml2
-rwxr-xr-xvirt-top/virt_top.mli2
-rwxr-xr-xvirt-top/virt_top_calendar1.ml2
-rwxr-xr-xvirt-top/virt_top_calendar2.ml2
-rw-r--r--virt-top/virt_top_csv.ml2
-rw-r--r--virt-top/virt_top_main.ml2
-rw-r--r--virt-top/virt_top_utils.ml2
-rwxr-xr-xvirt-top/virt_top_utils.mli2
-rw-r--r--virt-top/virt_top_version.ml.in2
-rw-r--r--virt-top/virt_top_xml.ml2
15 files changed, 42 insertions, 18 deletions
diff --git a/virt-top/README b/HACKING
index b594f95..bce40a9 100755..100644
--- 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:
diff --git a/Make.rules.in b/Make.rules.in
index a25d485..35af848 100644
--- a/Make.rules.in
+++ b/Make.rules.in
@@ -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
diff --git a/Makefile.in b/Makefile.in
index c9a6786..ef2eadc 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -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
--- 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/
diff --git a/virt-top/Makefile.in b/virt-top/Makefile.in
index 6a782cb..34f1ad6 100755
--- a/virt-top/Makefile.in
+++ b/virt-top/Makefile.in
@@ -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
diff --git a/virt-top/virt_top.ml b/virt-top/virt_top.ml
index 4fb7b47..36b7e17 100644
--- a/virt-top/virt_top.ml
+++ b/virt-top/virt_top.ml
@@ -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
diff --git a/virt-top/virt_top.mli b/virt-top/virt_top.mli
index 790eb31..efa5f56 100755
--- a/virt-top/virt_top.mli
+++ b/virt-top/virt_top.mli
@@ -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
diff --git a/virt-top/virt_top_calendar1.ml b/virt-top/virt_top_calendar1.ml
index 779e62b..beac4ee 100755
--- a/virt-top/virt_top_calendar1.ml
+++ b/virt-top/virt_top_calendar1.ml
@@ -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
diff --git a/virt-top/virt_top_calendar2.ml b/virt-top/virt_top_calendar2.ml
index 3d042e3..184f2b9 100755
--- a/virt-top/virt_top_calendar2.ml
+++ b/virt-top/virt_top_calendar2.ml
@@ -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
diff --git a/virt-top/virt_top_csv.ml b/virt-top/virt_top_csv.ml
index 3393e3a..e048856 100644
--- a/virt-top/virt_top_csv.ml
+++ b/virt-top/virt_top_csv.ml
@@ -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
diff --git a/virt-top/virt_top_main.ml b/virt-top/virt_top_main.ml
index 4ab60ad..4e1c5b7 100644
--- a/virt-top/virt_top_main.ml
+++ b/virt-top/virt_top_main.ml
@@ -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
diff --git a/virt-top/virt_top_utils.ml b/virt-top/virt_top_utils.ml
index 69f442f..f858e0e 100644
--- a/virt-top/virt_top_utils.ml
+++ b/virt-top/virt_top_utils.ml
@@ -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
diff --git a/virt-top/virt_top_utils.mli b/virt-top/virt_top_utils.mli
index 5af26d4..5b71b31 100755
--- a/virt-top/virt_top_utils.mli
+++ b/virt-top/virt_top_utils.mli
@@ -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
diff --git a/virt-top/virt_top_version.ml.in b/virt-top/virt_top_version.ml.in
index 12d72fb..eaa1df1 100644
--- a/virt-top/virt_top_version.ml.in
+++ b/virt-top/virt_top_version.ml.in
@@ -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
diff --git a/virt-top/virt_top_xml.ml b/virt-top/virt_top_xml.ml
index 73a4906..ab291d3 100644
--- a/virt-top/virt_top_xml.ml
+++ b/virt-top/virt_top_xml.ml
@@ -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