From 0c445419dde3f421e1db1a63ba8395e5f81369e4 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <LukeShu@sbcglobal.net>
Date: Fri, 27 Jun 2014 19:39:02 -0400
Subject: Add some HACKING documentation

---
 src/lib/HACKING.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 src/lib/HACKING.md

(limited to 'src/lib/HACKING.md')

diff --git a/src/lib/HACKING.md b/src/lib/HACKING.md
new file mode 100644
index 0000000..8bebaf6
--- /dev/null
+++ b/src/lib/HACKING.md
@@ -0,0 +1,15 @@
+Special stuff about hacking ih the /src/lib directory:
+
+ - Everything should be GPLv2 AND GPLv3 compatible.  No GPLv3 only.
+ - Name a file `libre${NAME}` if it should be executable directly, or
+   `${name}.sh` if it should only be available to be sourced.
+ - When printing a message that is internal to /src/lib, and not part
+   of the programm calling the library; prefix the print command with
+   `_l`.  `_l()` is defined in `common.sh` (and `librelib`, since it
+   cannot use any libraries itself).
+ - When changing the message functions, be aware that some are
+   duplicated in:
+    * /src/chroot-tools/chcleanup
+    * /src/chroot-tools/distcc-tool
+    * /src/lib/librelib
+   And that they probably need to be updated as well.
-- 
cgit v1.2.2