Skip to content
Snippets Groups Projects
Commit 1c354577 authored by Michele Alberti's avatar Michele Alberti
Browse files

[kernel] Make explicit that Normalize_only is the default mode.

parent 2f10c9d2
No related branches found
No related tags found
No related merge requests found
...@@ -305,27 +305,27 @@ module type Specific_dir = sig ...@@ -305,27 +305,27 @@ module type Specific_dir = sig
(** @return whether the plugin <specific-dir> has been set. *) (** @return whether the plugin <specific-dir> has been set. *)
val get_dir: val get_dir:
?mode:[`Create_path | `Normalize_only | `Must_exist ] -> ?mode:[`Normalize_only | `Create_path | `Must_exist ] ->
string -> string ->
Filepath.Normalized.t Filepath.Normalized.t
(** [get_dir ?mode p] returns a local-path [p], relative to the plugin (** [get_dir ?mode p] returns a local-path [p], relative to the plugin
<specific-dir> directory, to a sub-directory of the plugin <specific-dir> <specific-dir> directory, to a sub-directory of the plugin <specific-dir>
directory. directory.
@param mode determines how to handle the resulting path: @param mode determines how to handle the resulting path:
+ [Normalize_only] just normalizes the resulting path (default).
+ [Create_path] creates the resulting path, if does not exist. + [Create_path] creates the resulting path, if does not exist.
+ [Normalize_only] just normalizes the resulting path.
+ [Must_exist] aborts if the resulting path does not exist. *) + [Must_exist] aborts if the resulting path does not exist. *)
val get_file: val get_file:
?mode:[`Create_path | `Normalize_only | `Must_exist ] -> ?mode:[`Normalize_only | `Create_path | `Must_exist ] ->
string -> string ->
Filepath.Normalized.t Filepath.Normalized.t
(** [get_file ?mode p] returns a local-path [p], relative to the plugin (** [get_file ?mode p] returns a local-path [p], relative to the plugin
<specific-dir> directory, to a file in the plugin <specific-dir> <specific-dir> directory, to a file in the plugin <specific-dir>
directory. directory.
@param mode determines how to handle the resulting path: @param mode determines how to handle the resulting path:
+ [Normalize_only] just normalizes the resulting path (default).
+ [Create_path] creates the dirname of resulting path, if does not exist. + [Create_path] creates the dirname of resulting path, if does not exist.
+ [Normalize_only] just normalizes the resulting path.
+ [Must_exist] aborts if the resulting path does not exist. *) + [Must_exist] aborts if the resulting path does not exist. *)
end end
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment