Revert 33068a, Debian Default-Stop runlevel. On request of the Debian package maintai...

[netatalk.git] / doc / DEVELOPER

diff --git a/doc/DEVELOPER b/doc/DEVELOPER
index 82d702d32a4d607e3052346462a2a43f046dcb1b..9ba1765bcf4fa9364f8be79be7f9349beb84a89b 100644 (file)
--- a/doc/DEVELOPER
+++ b/doc/DEVELOPER
@@ -1,20 +1,20 @@
-Information for Netatalk 1.5 Developers
-=======================================
+Information for Netatalk Developers
+===================================
 
 For basic installation instructions, see the INSTALL file.
 
-
-netatalk is an implementation of the AppleTalk Protocol Suite.  The
-current release contains support for EtherTalk Phase I and II, DDP,
-RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, and AFP.  The complete stack looks
-like this on a BSD-derived system:
-
-    AFP
-     |
-    ASP    PAP
-      \   /
-       ATP RTMP NBP ZIP AEP
-       |    |   |   |   |
+Netatalk is an implementation of "AFP over TCP".
+Netatalk also support the AppleTalk Protocol Suite for legacy Macs.
+The current release contains support for EtherTalk Phase I and II, 
+DDP, RTMP, NBP, ZIP, AEP, ATP, PAP, ASP, AFP and DSI.
+The complete stack looks like this on a BSD-derived system:
+
+    AFP                          AFP
+     |                            |
+    ASP    PAP                   DSI
+      \   /                       |
+       ATP RTMP NBP ZIP AEP       |
+        |    |   |   |   |        |
    -+---------------------------------------------------+- (kernel boundary)
     |                    Socket                         |
     +-----------------------+------------+--------------+
@@ -25,6 +25,7 @@ like this on a BSD-derived system:
     |                Network-Interface                  |
     +---------------------------------------------------+
 
+DSI is a session layer used to carry AFP over TCP.
 DDP is in the kernel.  "atalkd" implements RTMP, NBP, ZIP, and AEP.  It
 is the AppleTalk equivalent of Unix "routed".  There is also a
 client-stub library for NBP.  ATP and ASP are implemented as
@@ -143,18 +144,82 @@ Author: Andrew Morgan <morgan@linux.kernel.org>
 
 Linux-PAM is a suite of shared libraries that enable the local system
 administrator to choose how applications authenticate users.
-
 You can get the Linux PAM documentation and sources from
 http://www.kernel.org/pub/linux/libs/pam/
-
 Netatalk also supports other standard PAM implementations such as OpenPAM.
 
-8 Berkeley DB
+8. Berkeley DB
 Berkeley DB is a programmatic toolkit that provides fast, reliable,
 scalable, and mission-critical database support to software
 developers. BDB can downloaded from
-http://www.sleepycat.com/download.html
+http://www.oracle.com/database/berkeley-db/index.html
 Netatalk's CNID database uses the library and header files from BDB.
-Currently, Netatalk supports BDB 4.1.25 and 4.2.52.
-The recommended version is 4.2.52 as that is the version on which most
-testing has been done.
+Currently, Netatalk supports BDB 4.6 and later.
+
+Error checking and logging
+==========================
+We wan't rigid error checking and concise log messages. This often leads
+to signifant code bloat where the relevant function call is buried in error
+checking and logging statements.
+In order to alleviate error checking and code readability, we provide a set
+of error checking macros in <atalk/errchk.h>. These macros compare the return
+value of statements againt 0, NULL, -1 (and maybe more, check it out).
+Every macro comes in four flavours: EC_CHECK, EC_CHECK_LOG, EC_CHECK_LOG_ERR
+and EC_CHECK_CUSTOM:
+- EC_CHECK just checks the CHECK
+- EC_CHECK_LOG additionally logs the stringified function call.
+- EC_CHECK_LOG_ERR allows specifying the return value
+- EC_CHECK_CUSTOM allows custom actions
+The macros EC_CHECK* unconditionally jump to a cleanup label where the
+neccessary cleanup can be done alongside controlling the return value.
+EC_CHECK_CUSTOM doesn't do that, so an extra "goto EC_CLEANUP" may be
+performed as appropiate.
+
+Example:
+- stat() without EC macro:
+  static int func(const char *name) {
+    int ret = 0;
+    ...
+    if ((ret = stat(name, &some_struct_stat)) != 0) {
+      LOG(...);
+      ret = -1; /* often needed to explicitly set the error indicating return value */
+      goto cleanup;
+    }
+
+    return ret;
+
+  cleanup:
+    ...
+    return ret;
+  }
+
+- stat() with EC macro:
+  static int func(const char *name) {
+    EC_INIT; /* expands to int ret = 0; */
+
+    char *uppername = NULL
+    EC_NULL(uppername = strdup(name));
+    EC_ZERO(strtoupper(uppername));
+
+    EC_ZERO(stat(uppername, &some_struct_stat)); /* expands to complete if block from above */
+
+    EC_STATUS(0);
+
+EC_CLEANUP:
+    if (uppername) free(uppername);
+    EC_EXIT;
+  }
+
+A boileplate function template is:
+
+int func(void)
+{
+    EC_INIT;
+
+    ...your code here...
+
+    EC_STATUS(0);
+
+EC_CLEANUP:
+    EC_EXIT;
+}