From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Tue, 13 Jun 2017 14:16:16 +0000 (+0200)
Subject: lua kres-gen: add a guide to re-generating
X-Git-Tag: v1.3.1~4^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=918c76621e7afd2e584ff25c90343b00bec5aa3e;p=thirdparty%2Fknot-resolver.git

lua kres-gen: add a guide to re-generating
---

diff --git a/daemon/lua/kres-gen.sh b/daemon/lua/kres-gen.sh
index e769583b1..40d501470 100755
--- a/daemon/lua/kres-gen.sh
+++ b/daemon/lua/kres-gen.sh
@@ -1,5 +1,19 @@
 #!/bin/sh -e
 
+### Dev's guide
+#
+# C declarations for lua are (mostly) generated to simplify maintenance.
+# (Avoid typos, accidental mismatches, etc.)
+#
+# To regenerate the C definitions for lua:
+# - you need to have debugging symbols for knot-dns and kresd;
+#   you get those by compiling with -g; for knot-dns it might be enough
+#   to just install it with debugging symbols included (in your distro way)
+# - remove file ./kres-gen.lua and run make as usual
+# - the knot-dns libraries are found via pkg-config
+# - you also need gdb on $PATH
+
+
 printf -- "--[[ This file is generated by ./kres-gen.sh ]] ffi.cdef[[\n"
 
 ## Various types (mainly), from libknot and libkres