New API: inspect-get-hostname to return the hostname of the guest.

[libguestfs.git] / HACKING

diff --git a/HACKING b/HACKING
index 9cc16c3..42f0f3a 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -7,8 +7,8 @@ Adding a new action
 All action functions are generated automatically, so there are only
 two files you need to edit:
 
 All action functions are generated automatically, so there are only
 two files you need to edit:
 

-(1) src/generator.ml: Add your new action, parameters, description,
-etc. to the big list called 'functions' at the top of this file.
+(1) generator/generator_actions.ml: Add your new action, parameters,
+description, etc. to the big list at the top of this file.

 
 (2) Edit/create a C file in daemon/ subdirectory which implements your
 'do_action' function.  Take a look at one of the numerous examples
 
 (2) Edit/create a C file in daemon/ subdirectory which implements your
 'do_action' function.  Take a look at one of the numerous examples


@@ -71,9 +71,15 @@ appliance/
 capitests/
         Automated tests of the C API.
 
 capitests/
         Automated tests of the C API.
 

+cat/
+        The 'virt-cat' command and documentation.
+

 contrib/
         Outside contributions, experimental parts.
 
 contrib/
         Outside contributions, experimental parts.
 

+csharp/
+        Experimental C# bindings.
+

 daemon/
         The daemon that runs inside the guest and carries out actions.
 
 daemon/
         The daemon that runs inside the guest and carries out actions.
 


@@ -86,12 +92,18 @@ fish/
 fuse/
         FUSE (userspace filesystem) built on top of libguestfs.
 
 fuse/
         FUSE (userspace filesystem) built on top of libguestfs.
 

+generator/
+        The crucially important generator, used to automatically
+        generate large amounts of boilerplate C code for things like
+        RPC and bindings.
+

 haskell/
         Haskell bindings.
 
 haskell/
         Haskell bindings.
 

-hivex/
-        Hive extraction library, for reading Windows Registry files.
-        See hivex/README for more details.
+hivex/ [removed in 1.0.85]
+       This used to contain the hivex library for reading and
+       writing Windows Registry binary hive files.  This is now
+       available as a separate upstream project.

 
 images/
         Some guest images to test against.  These are gzipped to save
 
 images/
         Some guest images to test against.  These are gzipped to save


@@ -111,8 +123,17 @@ m4/
 ocaml/
         OCaml bindings.
 
 ocaml/
         OCaml bindings.
 

+php/
+        PHP bindings.
+

 po/
 po/

-        Translations.
+        Translations of simple gettext strings.  For translations of
+        longer documents, see po-docs/.
+
+po-docs/
+        The build infrastructure and PO files for translations of
+        manpages and POD files.  Eventually this will be combined
+        with the po/ directory, but that is rather complicated.

 
 perl/
         Perl bindings.
 
 perl/
         Perl bindings.


@@ -127,14 +148,10 @@ ruby/
         Ruby bindings.
 
 tools/
         Ruby bindings.
 
 tools/

-        Command line tools like virt-cat, virt-df, virt-edit and more.
-        In versions <= 1.0.73 these were all in separate directories
-        like cat/, df/, edit/, but since then we moved them all into
-        one directory to simplify builds.
+        Command line tools like virt-df, virt-edit and more.

 
 src/
         Source code to the C library.
 
 src/
         Source code to the C library.

-        Also contains the crucial generator program.

 
 test-tool/
         Interactive qemu/kernel test tool.
 
 test-tool/
         Interactive qemu/kernel test tool.