Mailing list for all users of the OCaml language and system.
 help / color / mirror / Atom feed
From: Ashish Agarwal <agarwal1975@gmail.com>
To: Thomas Gazagnaire <thomas@ocamlpro.com>
Cc: "OCaml mailing-list" <caml-list@inria.fr>,
	"Daniel Bünzli" <daniel.buenzli@erratique.ch>
Subject: Re: [Caml-list] [RFC] new OPAM command-line interface
Date: Tue, 18 Dec 2012 12:00:25 -0500	[thread overview]
Message-ID: <CAMu2m2LdXea-3d7cAD00Ofi38AWXmcPRA6iFr7mkF1M9aJ_ekQ@mail.gmail.com> (raw)
In-Reply-To: <E9F66D7B-A8AA-4C49-8DE9-340A3CDF4908@ocamlpro.com>

[-- Attachment #1: Type: text/plain, Size: 2161 bytes --]

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 <thomas@ocamlpro.com>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 <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] 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

[-- Attachment #2: Type: text/html, Size: 3155 bytes --]

  parent reply	other threads:[~2012-12-18 17:00 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-12-14 18:09 Thomas Gazagnaire
2012-12-14 19:29 ` Wojciech Meyer
     [not found]   ` <28D2FDF4-81FB-4368-B331-7811DD606A0E@ocamlpro.com>
2012-12-14 23:15     ` Wojciech Meyer
2012-12-18 17:00 ` Ashish Agarwal [this message]
2013-01-03 11:26 ` [Caml-list] " Thomas Gazagnaire

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAMu2m2LdXea-3d7cAD00Ofi38AWXmcPRA6iFr7mkF1M9aJ_ekQ@mail.gmail.com \
    --to=agarwal1975@gmail.com \
    --cc=caml-list@inria.fr \
    --cc=daniel.buenzli@erratique.ch \
    --cc=thomas@ocamlpro.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox