From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Original-To: caml-list@sympa.inria.fr Delivered-To: caml-list@sympa.inria.fr Received: from mail1-relais-roc.national.inria.fr (mail1-relais-roc.national.inria.fr [192.134.164.82]) by sympa.inria.fr (Postfix) with ESMTPS id BC4DD7F2AA for ; Tue, 18 Dec 2012 18:00:46 +0100 (CET) Received-SPF: None (mail1-smtp-roc.national.inria.fr: no sender authenticity information available from domain of agarwal1975@gmail.com) identity=pra; client-ip=209.85.215.43; receiver=mail1-smtp-roc.national.inria.fr; envelope-from="agarwal1975@gmail.com"; x-sender="agarwal1975@gmail.com"; x-conformance=sidf_compatible Received-SPF: Pass (mail1-smtp-roc.national.inria.fr: domain of agarwal1975@gmail.com designates 209.85.215.43 as permitted sender) identity=mailfrom; client-ip=209.85.215.43; receiver=mail1-smtp-roc.national.inria.fr; envelope-from="agarwal1975@gmail.com"; x-sender="agarwal1975@gmail.com"; x-conformance=sidf_compatible; x-record-type="v=spf1" Received-SPF: None (mail1-smtp-roc.national.inria.fr: no sender authenticity information available from domain of postmaster@mail-la0-f43.google.com) identity=helo; client-ip=209.85.215.43; receiver=mail1-smtp-roc.national.inria.fr; envelope-from="agarwal1975@gmail.com"; x-sender="postmaster@mail-la0-f43.google.com"; x-conformance=sidf_compatible X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: AvkBALOg0FDRVdcrk2dsb2JhbABFq1oziQsBiQgIFg4BAQEBCQkLCRQEI4IeAQEEAUABGxILAQMBCwYFCxohIgERAQUBChIGEwgKAodsAQMJBgyZb4wzgXGBCoUMChknAwpZiHYBBQyMPYRDA4hhiXaDM4EcjUwWKYQy X-IronPort-AV: E=Sophos;i="4.84,309,1355094000"; d="scan'208";a="186721876" Received: from mail-la0-f43.google.com ([209.85.215.43]) by mail1-smtp-roc.national.inria.fr with ESMTP/TLS/RC4-SHA; 18 Dec 2012 18:00:46 +0100 Received: by mail-la0-f43.google.com with SMTP id z14so762256lag.16 for ; Tue, 18 Dec 2012 09:00:45 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type; bh=v9s9Kvu/ArNL2Daljzg20feEm5ljX4dM01bOIIGj+yE=; b=Do5elQtORXfcwN4IY1ahMiJHqtOV4lwks5Nu1DuTDZ3bzC8IsPVHbb1cA88S7KSSa/ 47dsu5gf+vxOrbfC8vuRiZqSzrjJHF1Srw1zEKVl5tvCSpUhkxw+teoxBDYJTIp6zH1G pO0AHJm24CBxGmjSW23iUR0kNcClhQpc1yL6dMjZV9CxWqVUxJUoMtZXXMuGw4Ydp3yO IAEpNimQ2uISA9zjoyI/GR+IbCT9uDRzvLW2nUWcVtoIi7RxvTHMP0aYBYJ9+GwI8a3S BPNF6mwL7XVPatq0zWypGwwDoolF3AX39r5bg/NfgvJ2TtupqLolhWC6JNhFBqv6co/e MP0Q== Received: by 10.152.108.42 with SMTP id hh10mr2520495lab.4.1355850045183; Tue, 18 Dec 2012 09:00:45 -0800 (PST) MIME-Version: 1.0 Received: by 10.112.21.102 with HTTP; Tue, 18 Dec 2012 09:00:25 -0800 (PST) In-Reply-To: References: From: Ashish Agarwal Date: Tue, 18 Dec 2012 12:00:25 -0500 Message-ID: To: Thomas Gazagnaire Cc: OCaml mailing-list , =?ISO-8859-1?Q?Daniel_B=FCnzli?= Content-Type: multipart/alternative; boundary=bcaec54fb9c64fd6b504d12370e6 Subject: Re: [Caml-list] [RFC] new OPAM command-line interface --bcaec54fb9c64fd6b504d12370e6 Content-Type: text/plain; charset=ISO-8859-1 Hi. The new interface is nice! A couple of minor comments: When you have sub-commands, I think it's best to make the options come after the last sub-command. The synopsis for opam switch suggests you can put options before the second sub-command. This might be okay if the option really relates to the first sub-command, but I don't see that in this case. I'm not a fan of having too many names for the same thing. For example, in opam switch, there is "add = install, rm = remove, and show = current". Better to just pick one. The single letter -o and longer --option is okay, especially for highly used options. Thanks. On Fri, Dec 14, 2012 at 1:09 PM, Thomas Gazagnaire wrote: > Hi, > > In order to prepare the beta release of OPAM (which should hopefully be > announced at the end of next week if everything goes well), I've been > working on improving its command-line interface (which is currently a bit > had-hoc). Thanks to the great Daniel Bunzli's cmdliner[1] library, I now > have a nice -- but incompatible -- command-line interface in the 'cmdliner' > branch[2]. > > The main changes are: > * an uniform help interface, where all flags and parameters are correctly > documents > * no more -long-option, only -s or --long > * 'opam remote' is still there for convenience but will be deprecated; use > 'opam repository' instead > * use of sub-sub-commands when necessary (ie. 'opam repository add') > * use non-ambiguous prefix of sub-command instead of the subcommand (ie. > 'opam repo' or 'opam rem') > * AND: a nice 'opam --help' and 'opam --help' output > > I'm quite keen to get community feedback on this new command-line. Feel > free to comment here, or to to use the issue tracker[3]. > > Cheers, > Thomas > > [1] http://erratique.ch/software/cmdliner > [2] git clone -b cmdliner git://github.com/OCamlPro/opam.git > [3] https://github.com/OCamlPro/opam/issues/157 > > > > > -- > Caml-list mailing list. Subscription management and archives: > https://sympa.inria.fr/sympa/arc/caml-list > Beginner's list: http://groups.yahoo.com/group/ocaml_beginners > Bug reports: http://caml.inria.fr/bin/caml-bugs --bcaec54fb9c64fd6b504d12370e6 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Hi. The new interface is nice! A couple of minor comments:

When you have sub-commands, I think it's best to make the options co= me after the last sub-command. The synopsis for opam switch suggests you ca= n put options before the second sub-command. This might be okay if the opti= on really relates to the first sub-command, but I don't see that in thi= s case.

I'm not a fan of having too many names for the same= thing. For example, in opam switch, there is "add =3D install, rm =3D= remove, and show =3D current". Better to just pick one. The single le= tter -o and longer --option is okay, especially for highly used options.

Thanks.

On Fri, Dec 1= 4, 2012 at 1:09 PM, Thomas Gazagnaire <thomas@ocamlpro.com> wrote:
Hi,

In order to prepare the beta release of OPAM (which should hopefully be ann= ounced at the end of next week if everything goes well), I've been work= ing on improving its command-line interface (which is currently a bit had-h= oc). Thanks to the great Daniel Bunzli's cmdliner[1] library, I now hav= e a nice -- but incompatible -- command-line interface in the 'cmdliner= ' branch[2].

The main changes are:
* an uniform help interface, where all flags and parameters are correctly d= ocuments
* no more -long-option, only -s or --long
* 'opam remote' is still there for convenience but will be deprecat= ed; use 'opam repository' instead
* use of sub-sub-commands when necessary (ie. 'opam repository add'= )
* use non-ambiguous prefix of sub-command instead of the subcommand (ie. &#= 39;opam repo' or 'opam rem')
* AND: a nice 'opam --help' and 'opam <subcommand> --help= ' output

I'm quite keen to get community feedback on this new command-line. Feel= free to comment here, or to to use the issue tracker[3].

Cheers,
Thomas

[1] htt= p://erratique.ch/software/cmdliner
[2] git clone -b cmdliner git://github.com/OCamlPro/opam.git
[3] https://github.com/OCamlPro/opam/issues/157




--
Caml-list mailing list. =A0Subscription management and archives:
ht= tps://sympa.inria.fr/sympa/arc/caml-list
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
Bug reports: http://caml.inria.fr/bin/caml-bugs
<= br>
--bcaec54fb9c64fd6b504d12370e6--