From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Tue, 23 Jan 2018 03:33:16 +0000 (-0700)
Subject: Clarify use of xlat_unlang_push
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6f679b3f0ba25115e76cf9bbdb82b9518b1af64b;p=thirdparty%2Ffreeradius-server.git

Clarify use of xlat_unlang_push
---

diff --git a/src/main/xlat_unlang.c b/src/main/xlat_unlang.c
index e8ce167b38f..1450e0471b1 100644
--- a/src/main/xlat_unlang.c
+++ b/src/main/xlat_unlang.c
@@ -86,8 +86,8 @@ static unlang_t xlat_instruction = {
  * @param[out] out		Where to write the result of the expansion.
  * @param[in] request		to push xlat onto.
  * @param[in] exp		node to evaluate.
- * @param[in] top_frame		Set to UNLANG_TOP_FRAME if this is the shallowest nesting level.
- *				Set to UNLANG_SUB_FRAME if this is a nested expansion.
+ * @param[in] top_frame		Set to UNLANG_TOP_FRAME if the interpreter should return.
+ *				Set to UNLANG_SUB_FRAME if the interprer should continue.
  */
 void xlat_unlang_push(TALLOC_CTX *ctx, fr_value_box_t **out,
 		      REQUEST *request, xlat_exp_t const *exp, bool top_frame)