X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=HACKING;h=865ae20a00bd5805763441e3f471934eb6644d9c;hb=298cc147ee0015df2128f9efe0402004e9820b9c;hp=0a27b77fc5df3856e818f2c33e145d56f5a9c6c1;hpb=b9e8c84588873568b7fdfaeb9beb85466e84c8fa;p=guestfs-browser.git diff --git a/HACKING b/HACKING index 0a27b77..865ae20 100644 --- a/HACKING +++ b/HACKING @@ -1,5 +1,11 @@ -This document describes the software architecture of the Guestfs -Browser, useful if you want to hack on it. +This document describes the software architecture of the +guestfs-browser, useful if you want to hack on it. + +Patches +------- + +Patches should be sent to the virt-tools mailing list: +http://www.redhat.com/mailman/listinfo/virt-tools-list About OCaml ----------- @@ -7,7 +13,9 @@ About OCaml First of all about OCaml: Read the tutorial and other resources available from this site: - http://ocaml-tutorial.org/ + http://caml.inria.fr/ + http://mirror.ocamlcore.org/ocaml-tutorial.org/index.html + # http://ocaml-tutorial.org/ If you are using emacs, install tuareg-mode instead of using the built-in emacs mode (which sucks). vi users have a good built-in @@ -30,7 +38,7 @@ Threads and messages Because libvirt and libguestfs API calls are usually long-running, we have to use threads, making these API calls in one thread, while -another thread keeps the display updated. In Guestfs Browser we use +another thread keeps the display updated. In guestfs-browser we use two threads, and send messages between them. The main thread keeps the display updated and runs the glib main loop. The slave thread issues libvirt and libguestfs API calls serially. There is a FIFO @@ -64,7 +72,7 @@ Most modules alias short names for some common libvirt and libguestfs modules, eg: module C = Libvirt.Connect - module Q = Queue + module G = Guestfs So when you see a function such as 'C.connect_readonly', it's really the function 'connect_readonly' in the [nested] module