From 1c354577ff239a7a4ba2547da13f819f44461b3d Mon Sep 17 00:00:00 2001
From: Michele Alberti <michele.alberti@cea.fr>
Date: Thu, 23 Apr 2020 17:08:50 +0200
Subject: [PATCH] [kernel] Make explicit that Normalize_only is the default
mode.
---
src/kernel_services/cmdline_parameters/parameter_sig.mli | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/kernel_services/cmdline_parameters/parameter_sig.mli b/src/kernel_services/cmdline_parameters/parameter_sig.mli
index 9df2908bf46..15e512e3278 100644
--- a/src/kernel_services/cmdline_parameters/parameter_sig.mli
+++ b/src/kernel_services/cmdline_parameters/parameter_sig.mli
@@ -305,27 +305,27 @@ module type Specific_dir = sig
(** @return whether the plugin <specific-dir> has been set. *)
val get_dir:
- ?mode:[`Create_path | `Normalize_only | `Must_exist ] ->
+ ?mode:[`Normalize_only | `Create_path | `Must_exist ] ->
string ->
Filepath.Normalized.t
(** [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>
directory.
@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.
- + [Normalize_only] just normalizes the resulting path.
+ [Must_exist] aborts if the resulting path does not exist. *)
val get_file:
- ?mode:[`Create_path | `Normalize_only | `Must_exist ] ->
+ ?mode:[`Normalize_only | `Create_path | `Must_exist ] ->
string ->
Filepath.Normalized.t
(** [get_file ?mode p] returns a local-path [p], relative to the plugin
<specific-dir> directory, to a file in the plugin <specific-dir>
directory.
@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.
- + [Normalize_only] just normalizes the resulting path.
+ [Must_exist] aborts if the resulting path does not exist. *)
end
--
GitLab