doc REFACTOR always use module instead of model

Author: michalvasko

src/context.c

@@ -336,7 +336,7 @@ ly_ctx_new(const char *search_dir, uint16_t options, struct ly_ctx **new_ctx)
     /* init LYB hash lock */
     pthread_mutex_init(&ctx->lyb_hash_lock, NULL);
 
-    /* models list */
+    /* modules list */
     ctx->flags = options;
     if (search_dir) {
         search_dir_list = strdup(search_dir);
@@ -1383,7 +1383,7 @@ ly_ctx_destroy(struct ly_ctx *ctx)
         return;
     }
 
-    /* models list */
+    /* modules list */
     for ( ; ctx->list.count; ctx->list.count--) {
         fctx.mod = ctx->list.objs[ctx->list.count - 1];
 

src/context.h

@@ -240,8 +240,8 @@ LIBYANG_API_DECL LY_ERR ly_ctx_new(const char *search_dir, uint16_t options, str
  * This function loads the yang-library data from the given path. If you need to pass the data as
  * string, use ::::ly_ctx_new_ylmem(). Both functions extend functionality of ::ly_ctx_new() by loading
  * modules specified in the ietf-yang-library form into the context being created.
- * The preferred tree model revision is 2019-01-04. However, only the first module-set is processed and loaded
- * into the context. If there are no matching nodes from this tree, the legacy tree (originally from model revision 2016-04-09)
+ * The preferred tree module revision is 2019-01-04. However, only the first module-set is processed and loaded
+ * into the context. If there are no matching nodes from this tree, the legacy tree (originally from module revision 2016-04-09)
  * is processed. Note, that the modules are loaded the same way as in case of ::ly_ctx_load_module(), so the schema paths in the
  * yang-library data are ignored and the modules are loaded from the context's search locations. On the other hand, YANG features
  * of the modules are set as specified in the yang-library data.
@@ -401,7 +401,7 @@ LIBYANG_API_DECL uint32_t ly_ctx_get_modules_hash(const struct ly_ctx *ctx);
 typedef void (*ly_module_imp_data_free_clb)(void *module_data, void *user_data);
 
 /**
- * @brief Callback for retrieving missing included or imported models in a custom way.
+ * @brief Callback for retrieving missing included or imported modules in a custom way.
  *
  * When @p submod_name is provided, the submodule is requested instead of the module (in this case only
  * the module name without its revision is provided).
@@ -435,12 +435,12 @@ typedef LY_ERR (*ly_module_imp_clb)(const char *mod_name, const char *mod_rev, c
 LIBYANG_API_DECL ly_module_imp_clb ly_ctx_get_module_imp_clb(const struct ly_ctx *ctx, void **user_data);
 
 /**
- * @brief Set missing include or import module callback. It is meant to be used when the models
+ * @brief Set missing include or import module callback. It is meant to be used when the modules
  * are not locally available (such as when downloading modules from a NETCONF server), it should
  * not be required in other cases.
  *
  * @param[in] ctx Context that will use this callback.
- * @param[in] clb Callback responsible for returning the missing model.
+ * @param[in] clb Callback responsible for returning the missing module.
  * @param[in] user_data Arbitrary data that will always be passed to the callback @p clb.
  */
 LIBYANG_API_DECL void ly_ctx_set_module_imp_clb(struct ly_ctx *ctx, ly_module_imp_clb clb, void *user_data);
@@ -602,7 +602,7 @@ LIBYANG_API_DECL const struct lysp_submodule *ly_ctx_get_submodule2_latest(const
 LIBYANG_API_DECL uint32_t ly_ctx_internal_modules_count(const struct ly_ctx *ctx);
 
 /**
- * @brief Try to find the model in the searchpaths of @p ctx and load it into it. If custom missing
+ * @brief Try to find the module in the searchpaths of @p ctx and load it into it. If custom missing
  * module callback is set, it is used instead.
  *
  * The context itself is searched for the requested module first. If @p revision is not specified
@@ -618,7 +618,7 @@ LIBYANG_API_DECL uint32_t ly_ctx_internal_modules_count(const struct ly_ctx *ctx
  * The feature string '*' enables all and array of length 1 with only the terminating NULL explicitly disables all
  * the features. In case the parameter is NULL, the features are untouched - left disabled in newly loaded module or
  * with the current features settings in case the module is already present in the context.
- * @return Pointer to the data model structure, NULL if not found or some error occurred.
+ * @return Found module, NULL if not found or some error occurred.
  */
 LIBYANG_API_DECL struct lys_module *ly_ctx_load_module(struct ly_ctx *ctx, const char *name, const char *revision,
         const char **features);
@@ -655,7 +655,7 @@ LIBYANG_API_DECL LY_ERR ly_ctx_get_yanglib_data(const struct ly_ctx *ctx, struct
  * multiple contexts, the function should be called for each used context.
  *
  * All instance data are supposed to be freed before destroying the context using ::lyd_free_all(), for example.
- * Data models (schemas) are destroyed automatically as part of ::ly_ctx_destroy() call.
+ * Modules (schemas) are destroyed automatically as part of ::ly_ctx_destroy() call.
  *
  * Note that the data stored by user into the ::lysc_node.priv pointer are kept
  * untouched and the caller is responsible for freeing this private data.

src/ly_common.h

@@ -343,7 +343,7 @@ struct ly_ctx {
     struct ly_dict dict;              /**< dictionary to effectively store strings used in the context related structures */
     struct ly_set search_paths;       /**< set of directories where to search for schema's imports/includes */
     struct ly_set list;               /**< set of loaded YANG schemas */
-    ly_module_imp_clb imp_clb;        /**< optional callback for retrieving missing included or imported models */
+    ly_module_imp_clb imp_clb;        /**< optional callback for retrieving missing included or imported modules */
     void *imp_clb_data;               /**< optional private data for ::ly_ctx.imp_clb */
     struct lys_glob_unres unres;      /**< global unres, should be empty unless there are modules prepared for
                                            compilation if ::LY_CTX_EXPLICIT_COMPILE flag is set */

src/lyb.h

@@ -51,8 +51,8 @@ struct lysc_node;
  sb          = siblings_start
  se          = siblings_end
  siblings    = zero-LYB_SIZE_BYTES | (sb instance+ se)
- instance    = node_type model hash node
- model       = 16bit_zero | (model_name_length model_name revision)
+ instance    = node_type module hash node
+ module      = 16bit_zero | (module_name_length module_name revision)
  node        = opaq | leaflist | list | any | inner | leaf
  opaq        = opaq_data siblings
  leaflist    = sb leaf+ se
@@ -171,8 +171,8 @@ void lyd_lyb_ctx_free(struct lyd_ctx *lydctx);
 /* Just a helper macro */
 #define LYB_META_BYTES (LYB_INCHUNK_BYTES + LYB_SIZE_BYTES)
 
-/* model revision as XXXX XXXX XXXX XXXX (2B) (year is offset from 2000)
- *                   YYYY YYYM MMMD DDDD */
+/* module revision as XXXX XXXX XXXX XXXX (2B) (year is offset from 2000)
+ *                    YYYY YYYM MMMD DDDD */
 #define LYB_REV_YEAR_OFFSET 2000
 #define LYB_REV_YEAR_MASK   0xfe00U
 #define LYB_REV_YEAR_SHIFT  9

src/parser_data.h

@@ -230,7 +230,7 @@ struct ly_in;
  *
  * @param[in] ctx Context to connect with the tree being built here.
  * @param[in] parent Optional parent to connect the parsed nodes to. If provided, the data are expected to describe
- * a subtree of the YANG model instead of starting at the schema root.
+ * a subtree of the YANG module instead of starting at the schema root.
  * @param[in] in The input handle to provide the dumped data in the specified @p format to parse (and validate).
  * @param[in] format Format of the input data to be parsed. Can be 0 to try to detect format from the input handler.
  * @param[in] parse_options Options for parser, see @ref dataparseroptions.

src/parser_internal.h

@@ -225,7 +225,7 @@ LY_ERR yang_parse_module(struct lysp_yang_ctx **context, struct ly_in *in, struc
 /**
  * @brief Parse module from YIN data.
  *
- * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
+ * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_module after it's completly parsed.
  * @param[in] in Input structure.
  * @param[in,out] mod Prepared module structure where the parsed information, including the parsed
  * module structure, will be filled in.
@@ -236,7 +236,7 @@ LY_ERR yin_parse_module(struct lysp_yin_ctx **yin_ctx, struct ly_in *in, struct
 /**
  * @brief Parse submodule from YIN data.
  *
- * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_model after it's completly parsed.
+ * @param[in,out] yin_ctx Context created during parsing, is used to finalize lysp_module after it's completly parsed.
  * @param[in] ctx Libyang context.
  * @param[in] main_ctx Parser context of main module.
  * @param[in] in Input structure.

src/parser_lyb.c

@@ -444,7 +444,7 @@ lyb_parse_metadata(struct lyd_lyb_ctx *lybctx, const struct lysc_node *sparent,
 
     /* read attributes */
     for (i = 0; i < count; ++i) {
-        /* find model */
+        /* find module */
         ret = lyb_parse_module(lybctx->lybctx, &mod);
         LY_CHECK_GOTO(ret, cleanup);
 

src/parser_schema.h

@@ -97,8 +97,8 @@ typedef enum {
 /**
  * @brief Load a schema into the specified context.
  *
- * @param[in] ctx libyang context where to process the data model.
- * @param[in] in The input handle to provide the dumped data model in the specified format.
+ * @param[in] ctx libyang context to use.
+ * @param[in] in Input handle to provide the dumped module in the specified format.
  * @param[in] format Format of the schema to parse. Can be 0 to try to detect format from the input handler.
  * @param[in] features Array of features to enable ended with NULL. If NULL, no features are enabled.
  * @param[out] module Optional parsed module.
@@ -113,8 +113,8 @@ LIBYANG_API_DECL LY_ERR lys_parse(struct ly_ctx *ctx, struct ly_in *in, LYS_INFO
  * This function is considered for a simple use, if you have a complex use-case,
  * consider use of ::lys_parse() with a standalone input handler.
  *
- * @param[in] ctx libyang context where to process the data model.
- * @param[in] data The string containing the dumped data model in the specified format.
+ * @param[in] ctx libyang context to use.
+ * @param[in] data String containing the dumped module in the specified format.
  * @param[in] format Format of the schema to parse.
  * @param[out] module Optional parsed module.
  * @return LY_ERR value.
@@ -124,12 +124,12 @@ LIBYANG_API_DECL LY_ERR lys_parse_mem(struct ly_ctx *ctx, const char *data, LYS_
 /**
  * @brief Read a schema from file descriptor into the specified context.
  *
- * \note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
+ * @note Current implementation supports only reading data from standard (disk) file, not from sockets, pipes, etc.
  *
  * This function is considered for a simple use, if you have a complex use-case,
  * consider use of ::lys_parse() with a standalone input handler.
  *
- * @param[in] ctx libyang context where to process the data model.
+ * @param[in] ctx libyang context to use.
  * @param[in] fd File descriptor of a regular file (e.g. sockets are not supported) containing the schema
  *            in the specified format.
  * @param[in] format Format of the schema to parse.
@@ -144,8 +144,8 @@ LIBYANG_API_DECL LY_ERR lys_parse_fd(struct ly_ctx *ctx, int fd, LYS_INFORMAT fo
  * This function is considered for a simple use, if you have a complex use-case,
  * consider use of ::lys_parse() with a standalone input handler.
  *
- * @param[in] ctx libyang context where to process the data model.
- * @param[in] path Path to the file with the model in the specified format.
+ * @param[in] ctx libyang context to use.
+ * @param[in] path Path to the file with the module in the specified format.
  * @param[in] format Format of the schema to parse.
  * @param[out] module Optional parsed module.
  * @return LY_ERR value.

src/plugins_types/identityref.c

@@ -193,7 +193,7 @@ identityref_check_base(const struct lysc_ident *ident, struct lysc_type_identity
 /**
  * @brief Check if @p ident is not disabled.
  *
- * Identity is disabled if it is located in an unimplemented model or
+ * Identity is disabled if it is located in an unimplemented module or
  * it can be disabled by if-feature. Calling this function may invoke
  * the implementation of another module.
  *

src/printer_lyb.c

@@ -726,7 +726,7 @@ lyb_print_metadata(struct ly_out *out, const struct lyd_node *node, struct lyd_l
             continue;
         }
 
-        /* model */
+        /* module */
         LY_CHECK_RET(lyb_print_module(out, iter->annotation->module, lybctx->lybctx));
 
         /* annotation name with length */
@@ -1155,7 +1155,7 @@ lyb_print_node(struct ly_out *out, const struct lyd_node **printed_node, struct
     /* write node type */
     LY_CHECK_RET(lyb_print_lyb_type(out, node, lybctx));
 
-    /* write model info first */
+    /* write module info first */
     if (node->schema && ((node->flags & LYD_EXT) || !lysc_data_parent(node->schema))) {
         LY_CHECK_RET(lyb_print_module(out, node->schema->module, lybctx->lybctx));
     }