diff --git a/doc/developer/advance.tex b/doc/developer/advance.tex index 9aee2607d8bbd86d5253fafd78204550e84a696e..550af9e2716281c59706eaccf36d48be2555bef4 100644 --- a/doc/developer/advance.tex +++ b/doc/developer/advance.tex @@ -1338,12 +1338,12 @@ output can be associated to a debugging key with the optional argument \lstinline{~dkey} which takes an argument of abstract type \lstinline|category|. Each category must be registered through the \lstinline|register_category| -function which takes an optionnal parameter \lstinline|help| to provide a +function which takes an optional parameter \lstinline|help| to provide a short description for this category. You can define subcategories by putting colons in the registered name. For instance \lstinline|a:b:c| defines a subcategory \lstinline|c| of \lstinline|a:b|, itself a subcategory of -\lstinline|a|. User can then choose to output debugging messages belonging to a -given category (and its subcategories) with the +\lstinline|a|. The user can then choose to output debugging messages belonging +to a given category (and its subcategories) with the \lstinline{-plugin-msg-key <category>} option. In order to decide whether a message should be output, both level and category @@ -1371,7 +1371,7 @@ abstract type \sscodeidxdef{Log}{Messages}{warn\_category} \lstinline|warn_category|. Warning categories are distinct from plain categories, and must be registered with the \sscodeidxdef{Log}{Messages}{register\_warn\_category} -\lstinline|register_warn_category| function which takes an optionnal parameter +\lstinline|register_warn_category| function which takes an optional parameter \lstinline|help| to provide a short description for this warning category. As explained in the user manual~\cite{userman}, each category can be associated with a status that controls what will happen when a warning is triggered, from diff --git a/src/kernel_services/plugin_entry_points/kernel.ml b/src/kernel_services/plugin_entry_points/kernel.ml index 6860debfb8e71e96aabfa1428472eb9d389da8d8..4e2a2233550a4036a46e65b06da53607a8bd0f2f 100644 --- a/src/kernel_services/plugin_entry_points/kernel.ml +++ b/src/kernel_services/plugin_entry_points/kernel.ml @@ -49,7 +49,7 @@ let dkey_asm_contracts = register_category ~help:"inline assembly contracts" "asm:contracts" let dkey_ast = - register_category ~help:"prints the AST juste after Ast.compute" "ast" + register_category ~help:"prints the AST just after Ast.compute" "ast" let dkey_builtins = register_category ~help:"Cil builtins" "builtins" diff --git a/src/kernel_services/plugin_entry_points/log.ml b/src/kernel_services/plugin_entry_points/log.ml index f11c71db9edc6ebae0cc658d24d0fb4cea727364..75d6995d2cd6cf56d580e45ee65fdac12e2e135f 100644 --- a/src/kernel_services/plugin_entry_points/log.ml +++ b/src/kernel_services/plugin_entry_points/log.ml @@ -1287,7 +1287,7 @@ struct let print_one_elt fmt s = Format.fprintf fmt "%-*s : %s" max s (get_category_help s) in - (* level 0 just in case user ask to display all categories + (* level 0 just in case user asks to display all categories in an otherwise quiet run *) feedback ~level:0 "@[<v 2>Message categories for %s are:@;%a@]" label Format.(pp_print_list ~pp_sep:pp_print_cut print_one_elt) l @@ -1295,7 +1295,7 @@ struct let pp_all_warn_categories_status () = let l = get_all_warn_categories_status () in let (max, max_status), l = - (* We need the length of statuses so we convert them to string. *) + (* We need the length of statuses, so we convert them to strings. *) List.fold_left_map (fun (m, m') (s, status) -> let status = Format.asprintf "%a" pp_warn_status status in let max_s = max m (String.length s) in diff --git a/src/kernel_services/plugin_entry_points/log.mli b/src/kernel_services/plugin_entry_points/log.mli index 5f04999714c074080b33ddc6f21376a5050157f0..bc91ce3568924c256a6bba13047df082bb0c4549 100644 --- a/src/kernel_services/plugin_entry_points/log.mli +++ b/src/kernel_services/plugin_entry_points/log.mli @@ -283,7 +283,7 @@ module type Messages = sig Note: to enable a category's messages by default, add it (e.g. via [add_debug_keys]) after registration. @since Fluorine-20130401 - @before Frama-C+dev [?help] option was not present + @before Frama-C+dev [?help] parameter was not present *) val pp_category: Format.formatter -> category -> unit @@ -343,7 +343,7 @@ module type Messages = sig val register_warn_category: ?help:string -> string -> warn_category (** @see <https://frama-c.com/download/frama-c-plugin-development-guide.pdf> - @before Frama-C+dev [?help] option was not present + @before Frama-C+dev [?help] parameter was not present *) val is_warn_category: string -> bool