]> gitweb.michael.orlitzky.com - nagios-mode.git/commitdiff
README: update to mention the automated directive parsing.
authorMichael Orlitzky <michael@orlitzky.com>
Mon, 14 Nov 2022 13:27:14 +0000 (08:27 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Mon, 14 Nov 2022 13:27:14 +0000 (08:27 -0500)
README

diff --git a/README b/README
index a5ec6e57b2fab6d7d1ac20705d73a2c812aae3ba..b39a1b929fa9a4d4e1f6e9d7017e753407b3a358 100644 (file)
--- a/README
+++ b/README
@@ -37,13 +37,15 @@ that have a different syntax.
 The macros and object definitions are parsed from the Nagios source
 code. Object definitions are found within xdata/xodtemplate.h, while
 the macros are cleverly hidden within include/macros.h. Once they have
-been parsed, they are cuth and pasteth in to nagios-mode.
+been parsed, they are cut and pasted in to nagios-mode.el.
 
-The directives (or variables) are another story. There is no obvious
-way to parse the object variables from the source code. So, it's done
-the old-fashioned way: I use nagios-mode until I notice that one of my
-variables isn't highlighted. Then I add it. You can mail me these and
-I will probably add them.
+The directives are a bit tricker. They too are parsed from the Nagios
+source (xdata/xodtemplate.c), but not all of the names map nicely to
+internal C variables, so there's no explicit list of them. Instead we
+try to piece together the valid names based on what Nagios's config
+parser is looking for. It's possible that some have been overlooked.
+
+The helper scripts for this can be found in the "utils" directory.
 
 
 == Bugs et cetera ==