From: Nick Porter <nick@portercomputing.co.uk>
Date: Fri, 19 May 2023 08:35:11 +0000 (+0100)
Subject: Be consistent in call environment comments
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=76f6ffb746b09798de8668ef58b7f397753cfe7f;p=thirdparty%2Ffreeradius-server.git

Be consistent in call environment comments
---

diff --git a/src/lib/server/module_ctx.h b/src/lib/server/module_ctx.h
index 7f2f25aa5ac..3c8f6c50c1a 100644
--- a/src/lib/server/module_ctx.h
+++ b/src/lib/server/module_ctx.h
@@ -117,7 +117,7 @@ DIAG_ON(unused-function)
  *
  * @param[in] _dl_inst	of the module being called.
  * @param[in] _thread 	instance of the module being called.
- * @param[in] _env_data	Module environment data.
+ * @param[in] _env_data	Call environment data.
  * @param[in] _rctx	Resume ctx (if any).
  */
 #define MODULE_CTX(_dl_inst, _thread, _env_data, _rctx) &(module_ctx_t){ .inst = _dl_inst, .thread = _thread, .env_data = _env_data, .rctx = _rctx }
diff --git a/src/lib/unlang/module_priv.h b/src/lib/unlang/module_priv.h
index b1122159a50..74ce79bc33b 100644
--- a/src/lib/unlang/module_priv.h
+++ b/src/lib/unlang/module_priv.h
@@ -54,7 +54,7 @@ typedef struct {
 								///< shared between all threads, so we can't
 								///< cache thread-specific data in the #unlang_t.
 
-	void				*env_data;		//!< Expanded per call module environment tmpls.
+	void				*env_data;		//!< Expanded per call "call environment" tmpls.
 
 #ifndef NDEBUG
 	int				unlang_indent;		//!< Record what this was when we entered the module.
diff --git a/src/lib/unlang/xlat_ctx.h b/src/lib/unlang/xlat_ctx.h
index 19ca0961a7f..abcd2266c46 100644
--- a/src/lib/unlang/xlat_ctx.h
+++ b/src/lib/unlang/xlat_ctx.h
@@ -43,7 +43,7 @@ typedef struct {
 	void const			*inst;			//!< xlat instance data.
 	void				*thread;		//!< xlat threadinstance data.
 	module_ctx_t const		*mctx;			//!< Synthesised module calling ctx.
-	void				*env_data;		//!< Expanded module env data.
+	void				*env_data;		//!< Expanded call env data.
 	void				*rctx;			//!< Resume context.
 } xlat_ctx_t;
 
@@ -80,7 +80,7 @@ typedef struct {
  * @param[in] _inst	Instance data of the module being called.
  * @param[in] _thread 	Instance data of the thread being called.
  * @param[in] _mctx	Module ctx.
- * @param[in] _env_data	Expanded module env.
+ * @param[in] _env_data	Expanded call env.
  * @param[in] _rctx	resume ctx data.
  */
 #define XLAT_CTX(_inst, _thread, _mctx, _env_data, _rctx) &(xlat_ctx_t){ .inst = _inst, .thread = _thread, \
diff --git a/src/lib/unlang/xlat_eval.c b/src/lib/unlang/xlat_eval.c
index ea81109d47e..a00da575fcd 100644
--- a/src/lib/unlang/xlat_eval.c
+++ b/src/lib/unlang/xlat_eval.c
@@ -892,7 +892,7 @@ xlat_action_t xlat_frame_eval_resume(TALLOC_CTX *ctx, fr_dcursor_t *out,
  * @param[in] head		of the list to evaluate
  * @param[in,out] in		xlat node to evaluate.  Advanced as we process
  *				additional #xlat_exp_t.
- * @param[in] env_data		Expanded module env.
+ * @param[in] env_data		Expanded call env.
  * @param[in] result		of a previous nested evaluation.
  */
 xlat_action_t xlat_frame_eval_repeat(TALLOC_CTX *ctx, fr_dcursor_t *out,
diff --git a/src/lib/unlang/xlat_priv.h b/src/lib/unlang/xlat_priv.h
index f49aa329327..bd729081bc2 100644
--- a/src/lib/unlang/xlat_priv.h
+++ b/src/lib/unlang/xlat_priv.h
@@ -133,7 +133,7 @@ typedef struct {
 	xlat_input_type_t	input_type;		//!< The input type used inferred from the
 							///< bracketing style.
 
-	fr_dict_t const		*dict;			//!< Dictionary to use when resolving module env tmpls
+	fr_dict_t const		*dict;			//!< Dictionary to use when resolving call env tmpls
 } xlat_call_t;
 
 /** An xlat expansion node
diff --git a/src/modules/rlm_ldap/rlm_ldap.h b/src/modules/rlm_ldap/rlm_ldap.h
index 4f44c46f412..14397719269 100644
--- a/src/modules/rlm_ldap/rlm_ldap.h
+++ b/src/modules/rlm_ldap/rlm_ldap.h
@@ -125,7 +125,7 @@ typedef struct {
 	fr_trunk_conf_t	bind_trunk_conf;		//!< Trunk configuration for trunk used for bind auths
 } rlm_ldap_t;
 
-/** Module environment used in LDAP authorization
+/** Call environment used in LDAP authorization
  *
  */
 typedef struct {
diff --git a/src/modules/rlm_smtp/rlm_smtp.c b/src/modules/rlm_smtp/rlm_smtp.c
index 3537ceb8bbd..c267bba869a 100644
--- a/src/modules/rlm_smtp/rlm_smtp.c
+++ b/src/modules/rlm_smtp/rlm_smtp.c
@@ -62,7 +62,7 @@ global_lib_autoinst_t const * const rlm_smtp_lib[] = {
 	GLOBAL_LIB_TERMINATOR
 };
 
-/** Module environment for sending emails.
+/** Call environment for sending emails.
 */
 typedef struct {
 	fr_value_box_t		username;		//!< User to authenticate as when sending emails.