lsyncd-conf.lua

@@ -1,3 +1,8 @@
+----
+-- User configuration file for lsyncd.
+--
+-- TODO documentation-
+--
 settings = {
 	logfile = "/tmp/lsyncd",
 	nodaemon,

lsyncd.c

@@ -1,3 +1,14 @@
+/** 
+ * lsyncd.c   Live (Mirror) Syncing Demon
+ *
+ * License: GPLv2 (see COPYING) or any later version
+ *
+ * Authors: Axel Kittenberger <axkibe@gmail.com>
+ *
+ * This is the core. It contains as minimal as possible glues 
+ * to the operating system needed for lsyncd operation. All high-level
+ * logic is coded (when feasable) into lsyncd.lua
+ */
 #include "config.h"
 #define LUA_USE_APICHECK 1
 
@@ -561,6 +572,8 @@ main(int argc, char *argv[])
 	/* the Lua interpreter */
 	lua_State* L;
 
+	/* TODO check lua version */
+
 	/* load Lua */
 	L = lua_open();
 	luaL_openlibs(L);

lsyncd.lua

@@ -1,8 +1,17 @@
 ------------------------------------------------------------------------------
--- lsyncd runner implemented in LUA
+-- lsyncd.lua   Live (Mirror) Syncing Demon
+--
+-- License: GPLv2 (see COPYING) or any later version
+--
+-- Authors: Axel Kittenberger <axkibe@gmail.com>
+--
+-- This is the "runner" part of lsyncd. It containts all its high-level logic.
+-- It works closely together with the lsyncd core in lsyncd.c. This means it
+-- cannot be runned directly from the standard lua interpreter.
 ------------------------------------------------------------------------------
 
 ----
+-- A security measurement.
 -- Core will exit if version ids mismatch.
 lsyncd_version = "2.0b1"