Restore signature of OpamStateConfig.opamroot

Author: dra27

master_changes.md

@@ -114,6 +114,7 @@ users)
 ## opam-repository
 
 ## opam-state
+ * `OpamStateConfig.opamroot_with_provenance`: restore previous behaviour to `OpamStateConfig.opamroot` for compatibility with third party code [#6047 @dra27]
 
 ## opam-solver
 

src/client/opamCliMain.ml

@@ -181,7 +181,7 @@ let check_and_run_external_commands () =
     let yes = if yes then Some (Some true) else None in
     OpamCoreConfig.init ?yes ?confirm_level ();
     OpamFormatConfig.init ();
-    let root_from, root_dir = OpamStateConfig.opamroot () in
+    let root_from, root_dir = OpamStateConfig.opamroot_with_provenance () in
     let has_init, root_upgraded =
       match OpamStateConfig.load_defaults ~lock_kind:`Lock_read root_dir with
       | None -> (false, false)

src/client/opamClientConfig.ml

@@ -209,7 +209,7 @@ let opam_init ?root_dir ?strict ?solver =
   let open OpamStd.Option.Op in
 
   (* (i) get root dir *)
-  let root_from, root = OpamStateConfig.opamroot ?root_dir () in
+  let root_from, root = OpamStateConfig.opamroot_with_provenance ?root_dir () in
 
   (* (ii) load conf file and set defaults *)
   (* the init for OpamFormat is done in advance since (a) it has an effect on

src/client/opamCommands.ml

@@ -94,7 +94,7 @@ let global_options cli =
       switch_to_updated_self
         OpamStd.Option.Op.(options.debug_level ++
                            OpamCoreConfig.E.debug () +! 0 |> abs > 0)
-        (snd (OpamStateConfig.opamroot ?root_dir:options.opt_root ()));
+        (OpamStateConfig.opamroot ?root_dir:options.opt_root ());
     let root_is_ok =
       OpamStd.Option.default false (OpamClientConfig.E.rootisok ())
     in

src/state/opamStateConfig.ml

@@ -223,7 +223,7 @@ let initk k =
 
 let init ?noop:_ = initk (fun () -> ())
 
-let opamroot ?root_dir () =
+let opamroot_with_provenance ?root_dir () =
   match root_dir with
   | Some root -> `Command_line, win_space_redirection root
   | None ->
@@ -233,6 +233,8 @@ let opamroot ?root_dir () =
     | None ->
       `Default, default.root_dir
 
+let opamroot ?root_dir () = snd (opamroot_with_provenance ?root_dir ())
+
 let is_newer_raw = function
   | Some v ->
     OpamVersion.compare v OpamFile.Config.root_version > 0

src/state/opamStateConfig.mli

@@ -86,7 +86,10 @@ val default : t
 (** Get the initial opam root value (from default, env or optional argument).
     This allows one to get it before doing the init, which is useful to get the
     configuration file used to fill some options to init() *)
-val opamroot: ?root_dir:dirname -> unit -> provenance * dirname
+val opamroot_with_provenance: ?root_dir:dirname -> unit -> provenance * dirname
+
+(** [opamroot ?root_dir () = snd (opamroot_with_provenance ?root_dir ()] *)
+val opamroot: ?root_dir:dirname -> unit -> dirname
 
 (** Loads the global configuration file, protecting against concurrent writes *)
 val load: ?lock_kind: 'a lock -> dirname -> OpamFile.Config.t option