From 3dda5509137fe54030207e322b16a9f906d35cee Mon Sep 17 00:00:00 2001
From: Allan Blanchard <allan.blanchard@cea.fr>
Date: Wed, 11 May 2022 09:28:13 +0200
Subject: [PATCH] [doc] Document a few API changes
---
.../ast_queries/cil_datatype.mli | 1 -
.../plugin_entry_points/db.mli | 2 +
.../plugin_entry_points/dynamic.mli | 8 +++-
src/libraries/datatype/datatype.mli | 44 +++++++++++++++----
4 files changed, 44 insertions(+), 11 deletions(-)
diff --git a/src/kernel_services/ast_queries/cil_datatype.mli b/src/kernel_services/ast_queries/cil_datatype.mli
index 24b5ade1d02..08df42ea3ba 100644
--- a/src/kernel_services/ast_queries/cil_datatype.mli
+++ b/src/kernel_services/ast_queries/cil_datatype.mli
@@ -268,7 +268,6 @@ module Varinfo: sig
val self: State.t
end
val dummy: t
- (**/**)
end
module Kf: sig
diff --git a/src/kernel_services/plugin_entry_points/db.mli b/src/kernel_services/plugin_entry_points/db.mli
index 2af2d50cac7..a3619aec348 100644
--- a/src/kernel_services/plugin_entry_points/db.mli
+++ b/src/kernel_services/plugin_entry_points/db.mli
@@ -63,6 +63,8 @@ val register_compute:
val register_guarded_compute:
(unit -> bool) ->
(unit -> unit) ref -> (unit -> unit) -> unit
+(** @before Frama-C+dev there was a string parameter (first position) that was
+ only used for Journalization, that has been removed. *)
(** Frama-C main interface.
@since Lithium-20081201
diff --git a/src/kernel_services/plugin_entry_points/dynamic.mli b/src/kernel_services/plugin_entry_points/dynamic.mli
index 97c81c930cb..57422faed10 100644
--- a/src/kernel_services/plugin_entry_points/dynamic.mli
+++ b/src/kernel_services/plugin_entry_points/dynamic.mli
@@ -35,6 +35,8 @@ val register:
[name], the type [ty] and the plug-in [plugin].
@raise Type.AlreadyExists if [name] already exists. In other words you
cannot register a value with the same name twice.
+ @before Frama-C+dev there was a labeled argument [journalized], that has
+ been removed when Journalization has been removed.
@plugin development guide *)
(* ************************************************************************* *)
@@ -155,7 +157,8 @@ end
*)
val load_packages: string list -> unit
-(** Load the module specification. See -load-module option. *)
+(** Load the module specification. See -load-module option.
+ @modify Magnesium-20151001 new API. *)
val load_module: string -> unit
(** Sets the load path for modules in FRAMAC_PLUGIN, prepending it with [path].
@@ -173,7 +176,8 @@ val is_loaded: string -> bool
val load_plugin_path: unit -> unit
(** Load all plugins in the path set with [set_module_load_path].
Must be invoked only once from boot during extending stage.
- @since Magnesium-20151001 new API. *)
+ @since Magnesium-20151001 new API.
+ @modify Phosphorus-20170501-beta1 changed signature. *)
(**/**)
(*
diff --git a/src/libraries/datatype/datatype.mli b/src/libraries/datatype/datatype.mli
index 6f06777de1f..50a1588d6d5 100644
--- a/src/libraries/datatype/datatype.mli
+++ b/src/libraries/datatype/datatype.mli
@@ -30,7 +30,10 @@
(* ********************************************************************** *)
(** Values associated to each datatype.
- Some others are provided directly in module {!Type}. *)
+ Some others are provided directly in module {!Type}.
+ @before Frama-C+dev there was additional fields only used for Journalization
+ that has been removed.
+*)
type 'a t = private
{ equal: 'a -> 'a -> bool;
compare: 'a -> 'a -> int;
@@ -45,7 +48,10 @@ module type Ty = sig
val ty: t Type.t
end
-(** All values associated to a datatype, excepted [copy]. *)
+(** All values associated to a datatype, excepted [copy].
+ @before Frama-C+dev there was several additional values only used for
+ Journalization that has been removed.
+*)
module type S_no_copy = sig
include Ty
@@ -122,7 +128,11 @@ val never_any_project: (Project_skeleton.t -> bool) -> 'a -> bool
@plugin development guide *)
(** Sub-signature of {!S}.
- @plugin development guide *)
+ @plugin development guide
+
+ @before Frama-C+dev there was several additional values only used for
+ Journalization that has been removed.
+*)
module type Undefined = sig
val structural_descr: Structural_descr.t
val equal: 'a -> 'a -> bool
@@ -157,7 +167,11 @@ module Serializable_undefined: Undefined
(** Input signature of {!Make} and {!Make_with_collections}.
Values to implement in order to get a datatype.
- Feel free to use easy builders (see above) for easy implementation. *)
+ Feel free to use easy builders (see above) for easy implementation.
+
+ @before Frama-C+dev there was several additional values only used for
+ Journalization that has been removed.
+*)
module type Make_input = sig
type t (** Type for this datatype *)
@@ -334,7 +348,11 @@ module type Polymorphic = sig
end
(** Functor for polymorphic types with only 1 type variable.
- @plugin development guide *)
+ @plugin development guide
+
+ @before Frama-C+dev the functor had several additional values only used for
+ Journalization that has been removed.
+*)
module Polymorphic
(P: sig
include Type.Polymorphic_input
@@ -357,7 +375,11 @@ module type Polymorphic2 = sig
end
(** Functor for polymorphic types with 2 type variables.
- @plugin development guide *)
+ @plugin development guide
+
+ @before Frama-C+dev the functor had several additional values only used for
+ Journalization that has been removed.
+*)
module Polymorphic2
(P: sig
include Type.Polymorphic2_input
@@ -387,7 +409,10 @@ end
(** Functor for polymorphic types with 3 type variables.
@since Oxygen-20120901
- @plugin development guide *)
+ @plugin development guide
+ @before Frama-C+dev the functor had several additional values only used for
+ Journalization that has been removed.
+*)
module Polymorphic3
(P: sig
include Type.Polymorphic3_input
@@ -425,7 +450,10 @@ end
(** Functor for polymorphic types with 4 type variables.
@since Oxygen-20120901
- @plugin development guide *)
+ @plugin development guide
+ @before Frama-C+dev the functor had several additional values only used for
+ Journalization that has been removed.
+*)
module Polymorphic4
(P: sig
include Type.Polymorphic4_input
--
GitLab