]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
update interpreter docs
authorAlan T. DeKok <aland@freeradius.org>
Fri, 24 Sep 2021 14:17:56 +0000 (10:17 -0400)
committerAlan T. DeKok <aland@freeradius.org>
Fri, 24 Sep 2021 14:17:56 +0000 (10:17 -0400)
doc/antora/modules/reference/nav.adoc
doc/antora/modules/reference/pages/unlang/index.adoc

index 3aa5b30032caf66060df9bcba24f3e8902d15661..0f66a474af7b4da525a0aa47cf38eab1374e7aae 100644 (file)
@@ -24,6 +24,8 @@
 **** xref:unlang/switch.adoc[switch]
 **** xref:unlang/update.adoc[update]
 
+*** xref:unlang/interpreter.adoc[Interpreter]
+
 *** xref:unlang/module.adoc[Modules]
 **** xref:unlang/module_method.adoc[Module Methods]
 **** xref:unlang/module_builtin.adoc[Built-in Modules]
index 887dbc5bcf2772aab122f88d39eccfbca03b39f7..4e21d1ca811dd6dfc612ca95e72dc34276bfd4cd 100644 (file)
@@ -41,6 +41,18 @@ load-balance {
 }
 ----
 
+== Interpreter
+
+The xref:unlang/interpreter.adoc[Interpreter] processes an input
+"request" packet, by running policies which contain
+xref:unlang/keywords.adoc[Keywords].  The result of the interpretation
+is usually an output "reply" packet.
+
+While the interpreter allows some fairly complex policies to be made,
+it is not a general purpose programming language.  The purpose of the
+language is to receive packets, process their contents, and send
+replies.  A secondary goal is to do that as quickly as possible.
+
 == Conditional Expressions
 
 xref:condition/index.adoc[Conditional expressions], which are used to check