[Cmdliner] Add alias option

           options that expand to others. Uses it for `--release` and `-p`.

           Fixes ocaml#4682 , the options are really used

Author: bobot

bin/common.ml

@@ -410,22 +410,12 @@ module Options_implied_by_dash_p = struct
     ; promote_install_files
     }
 
-  let release_options =
-    { root = Some "."
-    ; only_packages = No_restriction
-    ; ignore_promoted_rules = true
-    ; config_from_config_file = Dune_config.Partial.empty
-    ; profile = Some Profile.Release
-    ; default_target =
-        Arg.Dep.alias_rec ~dir:Path.Local.root Dune_engine.Alias.Name.install
-    ; always_show_command_line = true
-    ; promote_install_files = true
-    }
-
   let dash_dash_release =
-    let+ (_ : bool) =
       Arg.(
-        value & flag
+      value & alias ["--root";".";"--ignore-promoted-rules";"--no-config";
+                     "--profile";"release";"--always-show-command-line";
+                     "--promote-install-files";
+                     "--default-target";"@install"]
         & info [ "release" ] ~docs ~docv:"PACKAGES"
             ~doc:
               "Put $(b,dune) into a reproducible $(i,release) mode. This is in \
@@ -435,11 +425,10 @@ module Options_implied_by_dash_p = struct
                use this option for release builds. For instance, you must use \
                this option in your $(i,<package>.opam) files. Except if you \
                already use $(b,-p), as $(b,-p) implies this option.")
-    in
-    release_options
 
   let options =
-    let+ t = one_of options dash_dash_release
+    let+ t = options
+    and+ _ = dash_dash_release
     and+ only_packages =
       let+ names =
         Arg.(
@@ -463,11 +452,10 @@ module Options_implied_by_dash_p = struct
     { t with only_packages }
 
   let dash_p =
-    let+ pkgs, args =
       Term.with_used_args
         Arg.(
           value
-          & opt (some packages) None
+          & alias_opt (fun s -> ["--release";"--only-packages";s] )
           & info
               [ "p"; "for-release-of-packages" ]
               ~docs ~docv:"PACKAGES"
@@ -477,23 +465,17 @@ module Options_implied_by_dash_p = struct
                  order to build only what's necessary when your project \
                  contains multiple packages as well as getting reproducible \
                  builds.")
-    in
-    { release_options with
-      only_packages =
-        (match pkgs with
-        | None -> No_restriction
-        | Some names -> Restrict { names; command_line_option = List.hd args })
-    }
 
   let term =
-    let+ t = one_of options dash_p
+    let+ t = options
+    and+ _ = dash_p
     and+ profile =
       let doc =
         "Build profile. $(b,dev) if unspecified or $(b,release) if -p is set."
       in
       Arg.(
-        value
-        & opt (some profile) None
+        last
+        & opt_all (some profile) [None]
         & info [ "profile" ] ~docs
             ~env:(Arg.env_var ~doc "DUNE_PROFILE")
             ~doc:

test/blackbox-tests/test-cases/cmdline/profile.t/run.t

@@ -10,4 +10,4 @@
    ; profile = User_defined "bar"
 
   $ DUNE_PROFILE="bar" dune build -p foo --verbose 2>&1 | grep "; profile"
-   ; profile = User_defined "bar"
+   ; profile = Release

test/blackbox-tests/test-cases/github3530.t/run.t

@@ -2,15 +2,15 @@ When an empty string is passed to `-p`, we get a nice error message.
 
   $ echo '(lang dune 2.0)' > dune-project
   $ dune build -p ''
-  dune build: option `-p': Invalid package name: ""
+  dune build: option `--only-packages': Invalid package name: ""
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]
 
 This can happen in a list as well:
 
   $ dune build -p 'a,b,'
-  dune build: option `-p': Invalid package name: ""
+  dune build: option `--only-packages': Invalid package name: ""
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]

test/blackbox-tests/test-cases/misc.t/run.t

@@ -12,13 +12,13 @@ Test that incompatible options are properly reported
   [1]
 
   $ dune build -p toto --root .
-  dune build: Cannot use --root and -p simultaneously
+  dune build: option `--root' cannot be repeated
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]
 
   $ dune build --for-release-of-packages toto --root .
-  dune build: Cannot use --root and --for-release-of-packages simultaneously
+  dune build: option `--root' cannot be repeated
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]
@@ -30,13 +30,13 @@ Test that incompatible options are properly reported
   [1]
 
   $ dune build -p toto --release
-  dune build: Cannot use --release and -p simultaneously
+  dune build: option `--root' cannot be repeated
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]
 
   $ dune build --release --root .
-  dune build: Cannot use --root and --release simultaneously
+  dune build: option `--root' cannot be repeated
   Usage: dune build [OPTION]... [TARGET]...
   Try `dune build --help' or `dune --help' for more information.
   [1]

test/blackbox-tests/test-cases/vendor/dash-p-and-vendored-packages.t/run.t

@@ -49,5 +49,5 @@ Asking to keep "bar" makes no sense since it is vendored:
 
   $ dune exec -p foo,bar ./foo.exe
   Error: Package bar is vendored and so will never be masked. It is redundant
-  to pass it to -p.
+  to pass it to --only-packages.
   [1]

vendor/cmdliner/src/cmdliner.mli

@@ -657,6 +657,16 @@ module Arg : sig
       {b Note.} Environment variable lookup is unsupported for
       for these arguments. *)
 
+
+  val alias : string list -> info -> bool t
+  (** [alias l i] is a [flag i] except the arguments [l] are also parsed as
+     if they appeared in place of the option. *)
+
+  val alias_opt : (string -> string list) -> info -> bool t
+  (** [alias l i] is a [flag i] except the arguments [l arg] are also parsed as
+     if they appeared in place of the option. [arg] is the possible argument
+     given on the command line *)
+
   val opt : ?vopt:'a -> 'a conv -> 'a -> info -> 'a t
   (** [opt vopt c v i] is an ['a] argument defined by the value of
       an optional argument that may appear {e at most} once on the command

vendor/cmdliner/src/cmdliner_arg.ml

@@ -84,6 +84,31 @@ let list_to_args f l =
   let add acc v = Cmdliner_info.Args.add (f v) acc in
   List.fold_left add Cmdliner_info.Args.empty l
 
+let alias_opt aliases a =
+  let a = Cmdliner_info.arg_make_opt ~absent:Err ~kind:Opt a in
+  let aliases = (fun o -> assert (Option.is_some o); aliases (Option.get o)) in
+  let a = Cmdliner_info.arg_aliases ~aliases a in
+  if Cmdliner_info.arg_is_pos a then invalid_arg err_not_opt else
+  let convert ei cl = match Cmdliner_cline.opt_arg cl a with
+  | [] -> try_env ei a Cmdliner_base.env_bool_parse ~absent:false
+  | [_, _, None] -> Ok true
+  | [_, f, Some v] -> Ok true
+  | (_, f, _) :: (_ ,g, _) :: _  -> err (Cmdliner_msg.err_opt_repeated f g)
+  in
+  arg_to_args a, convert
+
+let alias aliases a =
+  let aliases = (fun o -> assert (Option.is_none o); aliases) in
+  let a = Cmdliner_info.arg_aliases ~aliases a in
+  if Cmdliner_info.arg_is_pos a then invalid_arg err_not_opt else
+  let convert ei cl = match Cmdliner_cline.opt_arg cl a with
+  | [] -> try_env ei a Cmdliner_base.env_bool_parse ~absent:false
+  | [_, _, None] -> Ok true
+  | [_, f, Some v] -> err (Cmdliner_msg.err_flag_value f v)
+  | (_, f, _) :: (_ ,g, _) :: _  -> err (Cmdliner_msg.err_opt_repeated f g)
+  in
+  arg_to_args a, convert
+
 let flag a =
   if Cmdliner_info.arg_is_pos a then invalid_arg err_not_opt else
   let convert ei cl = match Cmdliner_cline.opt_arg cl a with
@@ -290,6 +315,14 @@ let last (args, convert) =
   in
   args, convert
 
+let last_or_none (args, convert) =
+  let convert ei cl = match convert ei cl with
+  | Ok [] -> Ok None
+  | Ok l -> Ok (Some (List.hd (List.rev l)))
+  | Error _ as e -> e
+  in
+  args, convert
+
 (* Predefined arguments *)
 
 let man_fmts =

vendor/cmdliner/src/cmdliner_arg.mli

@@ -41,6 +41,8 @@ val flag : info -> bool t
 val flag_all : info -> bool list t
 val vflag : 'a -> ('a * info) list -> 'a t
 val vflag_all : 'a list -> ('a * info) list -> 'a list t
+val alias : string list -> info -> bool t
+val alias_opt : (string -> string list) -> info -> bool t
 val opt : ?vopt:'a -> 'a converter -> 'a -> info -> 'a t
 val opt_all : ?vopt:'a -> 'a converter -> 'a list -> info -> 'a list t
 

vendor/cmdliner/src/cmdliner_cline.ml

@@ -111,7 +111,8 @@ let parse_opt_args ~peek_opts optidx cl args =
               | v :: rest -> if is_opt v then None, args else Some v, rest
           in
           let arg = O ((k, name, value) :: opt_arg cl a) in
-          loop errs (k + 1) (Amap.add a arg cl) pargs args
+          loop errs (k + 1) (Amap.add a arg cl) pargs
+            ((Cmdliner_info.arg_alias a value)@args)
       | `Not_found when peek_opts -> loop errs (k + 1) cl pargs args
       | `Not_found ->
           let hints = hint_matching_opt optidx s in

vendor/cmdliner/src/cmdliner_info.ml

@@ -64,7 +64,9 @@ type arg =                     (* information about a command line argument. *)
     pos : pos_kind;                                  (* positional arg kind. *)
     opt_kind : opt_kind;                               (* optional arg kind. *)
     opt_names : string list;                        (* names (for opt args). *)
-    opt_all : bool; }                          (* repeatable (for opt args). *)
+    opt_all : bool;                            (* repeatable (for opt args). *)
+    opt_alias: string option -> string list;
+  }
 
 let dumb_pos = pos ~rev:false ~start:(-1) ~len:None
 
@@ -79,7 +81,8 @@ let arg ?docs ?(docv = "") ?(doc = "") ?env names =
       | _ -> Cmdliner_manpage.s_options
   in
   { id = new_id (); absent = Val (lazy ""); env; doc; docv; docs;
-    pos = dumb_pos; opt_kind = Flag; opt_names; opt_all = false; }
+    pos = dumb_pos; opt_kind = Flag; opt_names; opt_all = false;
+    opt_alias = fun _ -> [] }
 
 let arg_id a = a.id
 let arg_absent a = a.absent
@@ -99,6 +102,7 @@ let arg_opt_name_sample a =
   | n :: ns -> if (String.length n) > 2 then n else find ns
   in
   find a.opt_names
+let arg_alias a = a.opt_alias
 
 let arg_make_req a = { a with absent = Err }
 let arg_make_all_opts a = { a with opt_all = true }
@@ -108,6 +112,7 @@ let arg_make_opt_all ~absent ~kind:opt_kind a =
 
 let arg_make_pos ~pos a = { a with pos }
 let arg_make_pos_abs ~absent ~pos a = { a with absent; pos }
+let arg_aliases ~aliases a = { a with opt_alias = aliases }
 
 let arg_is_opt a = a.opt_names <> []
 let arg_is_pos a = a.opt_names = []

vendor/cmdliner/src/cmdliner_info.mli

@@ -56,13 +56,15 @@ val arg_opt_names : arg -> string list (* has dashes *)
 val arg_opt_name_sample : arg -> string (* warning must be an opt arg *)
 val arg_opt_kind : arg -> opt_kind
 val arg_pos : arg -> pos_kind
+val arg_alias : arg -> string option -> string list
 
 val arg_make_req : arg -> arg
 val arg_make_all_opts : arg -> arg
 val arg_make_opt : absent:arg_absence -> kind:opt_kind -> arg -> arg
 val arg_make_opt_all : absent:arg_absence -> kind:opt_kind -> arg -> arg
 val arg_make_pos : pos:pos_kind -> arg -> arg
 val arg_make_pos_abs : absent:arg_absence -> pos:pos_kind -> arg -> arg
+val arg_aliases : aliases:(string option -> string list) -> arg -> arg
 
 val arg_is_opt : arg -> bool
 val arg_is_pos : arg -> bool