Merge pull request #6917 from rjbou/path-names

Add modules to specify some path elements names

Author: kit-ty-kate

doc/index.html

@@ -110,8 +110,14 @@ <h1>opam %{OPAMVERSION}% API and libraries documentation</h1>
   <td>Definitions of many types used throughout</td></tr>
 <tr><th><a href="opam-format/OpamTypesBase">opamTypesBase.ml</a></th>
   <td>Helper functions on the base types. Often opened</td></tr>
+<tr><th><a href="opam-format/OpamPathName">opamPathName.ml</a></th>
+  <td>Defines the names of internal opam root elements</td></tr>
 <tr><th><a href="opam-format/OpamPath">opamPath.ml</a></th>
   <td>Defines the file hierarchy in ~/.opam</td></tr>
+<tr><th><a href="opam-repository/OpamRepositoryPathName">opamRepositoryPathName.ml</a></th>
+  <td>Defines the names of a repository elements layout</td></tr>
+<tr><th><a href="opam-repository/OpamRepositoryPath">opamRepositoryPath.ml</a></th>
+  <td>Defines the file hierarchy in repositories</td></tr>
 
 <tr><td colspan="2" class="sublib">Basic types, used as keys</td></tr>
 
@@ -160,8 +166,6 @@ <h1>opam %{OPAMVERSION}% API and libraries documentation</h1>
   <td>Configuration options for this lib (record, global reference, setter, initialisation)</td></tr>
 <tr><th><a href="opam-repository/OpamRepositoryBackend">opamRepositoryBackend.ml</a></th>
   <td>Signature for repository handlers and some helpers for the repository type</td></tr>
-<tr><th><a href="opam-repository/OpamRepositoryPath">opamRepositoryPath.ml</a></th>
-  <td>Defines the file hierarchy in repositories</td></tr>
 <tr><th><a href="opam-repository/OpamDownload">opamDownload.ml</a></th>
   <td>Configuration init and handling of downloading commands</td></tr>
 <tr><th><a href="opam-repository/OpamHTTP">opamHTTP.ml</a></th>

master_changes.md

@@ -207,6 +207,7 @@ users)
   * `OpamSolution.get_depexts` remove no longer needed `recover` option that was used with `--depext-only` option  [#6489 @arozovyk]
 
 ## opam-repository
+  * `OpamRepositoryPath` was moved to `opam-format` [#6917 @rjbou]
 
 ## opam-state
   * `OpamStateConfig.t`: replace `no_depexts` fields that contains disabling informations by `depexts` field that returns if the depexts mechanism is enabled. This field is automatically update by global config value in `OpamStateConfig.load_defaults` [#6489 @rjbou]
@@ -242,6 +243,9 @@ users)
   * `OpamSysPkg`: add `availability_mode` type to indicate the availability of system packages on a given system [#6489 @arozovyk]
   * `OpamSysPkg`: add `equal_availability_mode` function [#6489 @arozovyk]
   * `OpamTypes`: change `result` type name to `solver_result` to avoid conflicts with Stdlib [#6885 @rjbou]
+  * `OpamPathName` was added [#6917 @rjbou]
+  * `OpamRepositoryPathName` was added [#6917 @rjbou]
+  * `OpamRepositoryPath` was moved from `opam-repository` [#6917 @rjbou]
 
 ## opam-core
   * `OpamCmdliner` was added. It is accessible through a new `opam-core.cmdliner` sub-library [#6755 @kit-ty-kate]

src/client/opamAction.ml

@@ -354,7 +354,7 @@ let prepare_package_build env opam nv dir =
   in
   let print_subst basename =
     let file = OpamFilename.Base.to_string basename in
-    let file_in = file ^ ".in" in
+    let file_in = file ^ OpamPathName.subst_suffix in
     log "%s: expanding opam variables in %s, generating %s.\n"
       (OpamPackage.name_to_string nv)
       file_in file;

src/client/opamAdminCommand.ml

@@ -125,7 +125,7 @@ let index_command cli =
     OpamFile.Repo.write repo_file repo_def;
     if urls_txt <> `no_urls_txt then
       (OpamConsole.msg "Generating urls.txt...\n";
-       OpamFilename.of_string "repo" ::
+       OpamFilename.of_string OpamRepositoryPathName.repo_f ::
        (if urls_txt = `full_urls_txt then
           OpamFilename.rec_files OpamFilename.Op.(repo_root / "compilers") @
           OpamFilename.rec_files (OpamRepositoryPath.packages_dir repo_root)
@@ -837,7 +837,8 @@ let lint_command cli =
   let cmd global_options short list incl excl ign warn_error () =
     OpamArg.apply_global_options cli global_options;
     let repo_root = checked_repo_root () in
-    if not (OpamFilename.exists_dir OpamFilename.Op.(repo_root / "packages"))
+    if not (OpamFilename.exists_dir
+              OpamFilename.Op.(repo_root / OpamRepositoryPathName.packages_d))
     then
         OpamConsole.error_and_exit `Bad_arguments
           "No repository found in current directory.\n\

src/client/opamAuxCommands.ml

@@ -128,7 +128,7 @@ let opams_of_dir_w_target ?locked ?recurse ?subpath
 let name_and_dir_of_opam_file ?locked f =
   let srcdir = OpamFilename.dirname f in
   let srcdir =
-    if OpamFilename.dir_ends_with ".opam" srcdir &&
+    if OpamFilename.dir_ends_with OpamPathName.opam_suffix srcdir &&
        OpamUrl.guess_version_control (OpamFilename.Dir.to_string srcdir)
        = None
     then OpamFilename.dirname_dir srcdir

src/client/opamCommands.ml

@@ -3854,9 +3854,11 @@ let source cli =
             = None
          then
            let f =
-             if OpamFilename.exists_dir Op.(dir / "opam")
-             then OpamFile.make Op.(dir / "opam" // "opam")
-             else OpamFile.make Op.(dir // "opam")
+             let opam_f = OpamPathName.opam_f in
+             let opam_d = OpamPathName.opam_d in
+             if OpamFilename.exists_dir Op.(dir / opam_d)
+             then OpamFile.make Op.(dir / opam_d // opam_f)
+             else OpamFile.make Op.(dir // opam_f)
            in
            OpamFile.OPAM.write f
              (OpamFile.OPAM.with_substs [] @@

src/client/opamListCommand.ml

@@ -377,7 +377,7 @@ let apply_selector ~base st = function
        in
        let matching_change_files =
          List.filter (fun change_f ->
-             OpamFilename.check_suffix change_f ".changes" &&
+             OpamFilename.check_suffix change_f OpamPathName.changes_suffix &&
              let changes =
                OpamFile.Changes.safe_read (OpamFile.make change_f)
              in
@@ -870,7 +870,7 @@ let info st ~fields ~raw ~where ?normalise ?(show_empty=false)
     if where then
       OpamConsole.msg "%s\n"
         (match OpamFile.OPAM.metadata_dir opam with
-         | Some (None, dir) -> Filename.concat dir "opam"
+         | Some (None, dir) -> Filename.concat dir OpamPathName.opam_f
          | Some (Some repo, rdir) ->
            let repo_dir = OpamRepositoryPath.root st.switch_global.root repo in
            let tar = OpamRepositoryPath.tar st.switch_global.root repo in

src/client/opamPinCommand.ml

@@ -292,7 +292,7 @@ let edit st ?version name =
           OpamFile.OPAM.get_url opam >>= OpamUrl.local_dir >>| fun dir ->
           let src_opam =
               (OpamPinned.find_opam_file_in_source name dir >>| fst)
-              +! (OpamFile.make OpamFilename.Op.(dir // "opam"))
+              +! (OpamFile.make OpamFilename.Op.(dir // OpamPathName.opam_f))
           in
           let clean_opam =
             OpamFile.OPAM.with_url_opt None @*

src/format/opamFile.ml

@@ -2773,9 +2773,13 @@ module OPAMSyntax = struct
         | Some r, rel ->
           { pos_null with
             filename =
-              Printf.sprintf "<%s>/%s/opam" (OpamRepositoryName.to_string r) rel }
+              Printf.sprintf "<%s>/%s/%s"
+                (OpamRepositoryName.to_string r)
+                rel
+                OpamRepositoryPathName.opam_f }
         | None, d ->
-          pos_file OpamFilename.Op.(OpamFilename.Dir.of_string d // "opam")
+          let open OpamFilename.Op in
+          pos_file (OpamFilename.Dir.of_string d // OpamPathName.opam_f)
       in
       Pp.bad_format ?pos "Field '%s:' is required" name
     | Some n -> n
@@ -3661,7 +3665,7 @@ module OPAM = struct
     (match metadata_dir o with
      | None -> None
      | Some (None, abs) ->
-       let files_dir = OpamFilename.Dir.of_string abs / "files" in
+       let files_dir = OpamFilename.Dir.of_string abs / OpamPathName.files_d in
        extra_files o >>| List.map @@ fun (basename, hash) ->
        let content =
          let f = OpamFilename.create files_dir basename in
@@ -3672,7 +3676,10 @@ module OPAM = struct
        in
        (basename, content, hash)
      | Some (Some r, rel) ->
-       let files = get_repo_files r (rel ^ Filename.dir_sep ^ "files") in
+       let files =
+         get_repo_files r
+           (rel ^ Filename.dir_sep ^ OpamRepositoryPathName.files_d)
+       in
        extra_files o >>| List.map @@ fun (basename, hash) ->
        let content =
          OpamStd.List.assoc_opt OpamFilename.Base.equal basename files
@@ -3694,7 +3701,7 @@ module OPAM = struct
            Printf.sprintf " in %s" dir
          | _, _, _, Some (Some repo, dir) ->
            Printf.sprintf " %s from repository %s"
-             (Filename.concat dir "opam")
+             (Filename.concat dir OpamRepositoryPathName.opam_f)
              (OpamRepositoryName.to_string repo)
          | _ -> "")
         (OpamStd.Format.itemize

src/format/opamFilter.ml

@@ -463,7 +463,7 @@ let expand_interpolations_in_file_full env ~src ~dst =
 (* Substitute the file contents *)
 let expand_interpolations_in_file env file =
   let file = OpamFilename.of_basename file in
-  let src = OpamFilename.add_extension file "in" in
+  let src = OpamFilename.add_extension file OpamPathName.subst_ext in
   expand_interpolations_in_file_full env ~src ~dst:file
 
 (* Apply filters and interpolations to package commands *)