From 7f12b24e91844e01d93f7585a38e081831408884 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marek=20Vavru=C5=A1a?= <marek.vavrusa@nic.cz>
Date: Fri, 27 Mar 2015 14:26:28 +0100
Subject: [PATCH] daemon: updated doc
---
daemon/engine.c | 12 +++++------
doc/build.rst | 3 ++-
doc/config.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++--
doc/daemon.rst | 2 +-
doc/index.rst | 4 ++--
5 files changed, 61 insertions(+), 13 deletions(-)
diff --git a/daemon/engine.c b/daemon/engine.c
index d9d8f9ce2..75c050469 100644
--- a/daemon/engine.c
+++ b/daemon/engine.c
@@ -22,13 +22,6 @@
#include "lib/cache.h"
#include "lib/defines.h"
-/*
- * Defines
- */
-
-#define CACHE_DEFAULT_PATH "/tmp/kresolved"
-#define CACHE_DEFAULT_SIZE 10*(1024*1024)
-
/*
* Global bindings.
*/
@@ -39,6 +32,11 @@ static int l_help(lua_State *L)
static const char *help_str =
"help()\n show this help\n"
"quit()\n quit\n"
+ "modules.list()\n list modules\n"
+ "modules.load()\n load module\n"
+ "modules.unload()\n unload module\n"
+ "cache.open(path, max_size)\n open cache\n"
+ "cache.close()\n close cache\n"
;
puts(help_str);
/* No results */
diff --git a/doc/build.rst b/doc/build.rst
index b5b0a515e..7cc5742c9 100644
--- a/doc/build.rst
+++ b/doc/build.rst
@@ -32,11 +32,12 @@ The following is a list of software required to build Knot DNS Resolver from sou
"C compiler", "*all*", "*(build only)* [#]_"
"libknot_ 2.0+", "*all*", "Knot DNS library."
-There are also *optional* packages that enable specific functionality in Knot DNS Resolver, apart from the `libuv_` and `GCCGO`_, they are useful mainly for developers to build documentation and tests.
+There are also *optional* packages that enable specific functionality in Knot DNS Resolver, apart from the `libuv`_ and `GCCGO`_, they are useful mainly for developers to build documentation and tests.
.. csv-table::
:header: "Requirement", "Required by", "Notes"
+ "Lua_ 5.1+", "``daemon``", "Embeddable scripting language (LuaJIT_ is preferred)."
"libuv_ 1.0+", "``daemon``", "Multiplatform I/O and services."
"cmocka_", "``unit tests``", "Unit testing framework."
"Python_", "``integration tests``", "For scripting tests, C header files are required (``python-dev``)"
diff --git a/doc/config.rst b/doc/config.rst
index 153f84ac5..870950b22 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -1,2 +1,51 @@
-Configuration reference
------------------------
\ No newline at end of file
+Daemon configuration
+--------------------
+
+The Knot DNS Resolver daemon has no traditional concept of static configuration.
+In it's simplest form it requires just a working directory in which it can set up persistent files like
+cache and the process state.
+
+.. code-block:: sh
+
+ $ kresolved /var/run/kresolved
+
+And you're good to go!
+
+Introduction
+~~~~~~~~~~~~
+
+There are several choices on how you can configure the daemon, a RPC interface a CLI or a configuration file,
+but fortunately all share a common syntax and are transparent to each other, e.g. if you change a knob, you're going to
+see it projected to other interfaces as well.
+
+.. note:: Expect this page to change a lot, as it's still just a proof of concept implementation.
+
+Configuration 101
+~~~~~~~~~~~~~~~~~
+
+If there is a `config` file in the daemon working directory, it's going to get loaded automatically, if there isn't one
+the daemon is going to start with sane defaults and listening on `localhost`. The syntax for options is like follows: ``group.option = value``
+or ``group.action(parameters)``. You can also comment using a ``--`` prefix.
+
+A simple example would be to increase the cache size.
+
+.. code-block:: lua
+
+ -- increase the cache to 100MB
+ cache.open(".", 100*1024*1024)
+
+Dynamic configuration
+~~~~~~~~~~~~~~~~~~~~~
+
+Packages and services
+~~~~~~~~~~~~~~~~~~~~~
+
+The Lua supports a concept called closures, this is extremely useful for scripting actions upon various events.
+
+.. note:: TODO, come back later!
+
+* Timers and events
+* File watchers
+* Serialization
+* Data I/O
+
diff --git a/doc/daemon.rst b/doc/daemon.rst
index baf8c89e1..1cd4004a4 100644
--- a/doc/daemon.rst
+++ b/doc/daemon.rst
@@ -31,6 +31,6 @@ You can load modules this way and use their properties to get information about
$ kresolved /var/run/knot-resolver
...
[system] started in interactive mode, type 'help()'
- > module.load('cachectl')
+ > modules.load('cachectl')
> return cachectl.size()
{ "size": 53 }
\ No newline at end of file
diff --git a/doc/index.rst b/doc/index.rst
index 19deef18c..18f4d2e1f 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -9,10 +9,10 @@ Modular architecture of the library keeps the core tiny and efficient, and provi
:maxdepth: 2
build
- daemon
lib
- modules
+ daemon
config
+ modules
Indices and tables
--
GitLab