Combined binary.

[virt-mem.git] / HACKING

diff --git a/HACKING b/HACKING
new file mode 100644 (file)
index 0000000..82f4461
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,19 @@
+We build all the tools into a single virt-mem executable, in order to
+share the most runtime.  Almost all the code between individual tools
+is shared anyway.
+
+lib/
+
+ - The common core of all the tools.  Library, kernel symbols, command
+   line handling, memory images, etc.
+
+uname/
+dmesg/
+  etc.
+
+ - The code specific to each tool, usually rather small.
+
+mem/
+
+ - This brings everything together and links it into a single executable.
+   Other than that purpose, there is almost nothing in this directory.