Module Parameter_customize

module Parameter_customize: sig .. end
Configuration of command line options.

You can apply the below functions juste before applying one of the functors provided by the functor Plugin.Register and generating a new parameter.
Consult the Plugin Development Guide for additional details.


val set_cmdline_stage : Cmdline.stage -> unit
Set the stage where the option corresponding to the parameter is recognized. Default is Cmdline.Configuring.
Since Beryllium-20090601-beta1
val do_not_journalize : unit -> unit
Prevent journalization of the parameter.
Since Beryllium-20090601-beta1
val do_not_projectify : unit -> unit
Prevent projectification of the parameter: its state is shared by all the existing projects. Also imply Parameter_customize.do_not_save and Parameter_customize.do_not_reset_on_copy.
Since Beryllium-20090601-beta1
val do_not_reset_on_copy : unit -> unit
Prevents resetting the parameter to its default value when creating a project from a copy visitor.
Since Neon-20130301
val do_not_save : unit -> unit
Prevent serialization of the parameter.
Since Carbon-20110201
val set_negative_option_name : string -> unit
For boolean parameters, set the name of the negative option generating automatically from the positive one (the given option name). The default used value prefixes the given option name by "-no". Assume that the given string is a valid option name or empty. If it is empty, no negative option is created.
Since Beryllium-20090601-beta1
Consult the Plugin Development Guide for additional details.
val set_negative_option_help : string -> unit
For boolean parameters, set the help message of the negative option generating automatically. Assume that the given string is non empty.
Since Beryllium-20090601-beta1
val set_unset_option_name : string -> unit
For string collection parameters, set the name of an option that will remove elements from the set. There is no default value: if the this function is not called (or if it is the empty string), it will only be possible to add elements from the command line.
Since Fluorine-20130401
val set_unset_option_help : string -> unit
For string collection parameters, gives the help message for the corresponding unset option. Useless if set_unset_option_name has not been called before. No default.
Since Fluorine-20130401
val set_optional_help : (unit, Format.formatter, unit) Pervasives.format -> unit
Deprecated.since Oxygen-20120901: directly use the help string instead.
Concatenate an additional description just after the default one.
Since Beryllium-20090601-beta1
val set_group : Cmdline.Group.t -> unit
Affect a group to the parameter.
Since Beryllium-20090901
val is_invisible : unit -> unit
Prevent the help to list the parameter. Also imply Parameter_customize.do_not_iterate.
Since Carbon-20101201
Change in Nitrogen-20111001: does not appear in the help
val argument_is_function_name : unit -> unit
Indicate that the string argument of the parameter must be a valid function name (or a set of valid function names). A valid function name is the name of a function defined in the analysed C program. Do nothing if the following applied functor has type String, String_set or String_list.
Since Oxygen-20120901
val do_iterate : unit -> unit
Ensure that iter_on_plugins is applied to this parameter. By default only parameters corresponding to options registered at the Cmdline.Configuring stage are iterable.
Since Nitrogen-20111001
val do_not_iterate : unit -> unit
Prevent iter_on_plugins to be applied on the parameter. By default, only parameters corresponding to options registered at the Cmdline.Configuring stage are iterable.
Since Nitrogen-20111001