]> git.ipfire.org Git - thirdparty/freeradius-server.git/commitdiff
Be consistent in call environment comments
authorNick Porter <nick@portercomputing.co.uk>
Fri, 19 May 2023 08:35:11 +0000 (09:35 +0100)
committerNick Porter <nick@portercomputing.co.uk>
Fri, 19 May 2023 08:35:11 +0000 (09:35 +0100)
src/lib/server/module_ctx.h
src/lib/unlang/module_priv.h
src/lib/unlang/xlat_ctx.h
src/lib/unlang/xlat_eval.c
src/lib/unlang/xlat_priv.h
src/modules/rlm_ldap/rlm_ldap.h
src/modules/rlm_smtp/rlm_smtp.c

index 7f2f25aa5ac3e9feacc3bf97c7d399b88a2e64d1..3c8f6c50c1a92f9b0b9f63ab66a2c99df26f3230 100644 (file)
@@ -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 }
index b1122159a50f4723a2134aa68927febb438860b0..74ce79bc33ba3ef84e1e10e323a4678d258b441b 100644 (file)
@@ -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.
index 19ca0961a7f755875f1b144bf238667eb012a413..abcd2266c4669fb3e24f544e29406e3eb6455616 100644 (file)
@@ -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, \
index ea81109d47e34c462de44fbf3dae91d24889441c..a00da575fcdedecf0fb3384377bc820b41f74aab 100644 (file)
@@ -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,
index f49aa329327bc487a282928ee7c1084c89af2b8c..bd729081bc289cd1be89f65f7cada0535781d7b0 100644 (file)
@@ -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
index 4f44c46f412f4ede7833f4a29888248b7ff5afa1..14397719269a427e732fc43f179c953613aa678e 100644 (file)
@@ -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 {
index 3537ceb8bbdc81aea48e2f9dbe7b3db7a0114932..c267bba869ad9a17b99bd53b2bf5879ab7a25e39 100644 (file)
@@ -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.