caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
* [Caml-list] [ANN] Cmdliner 1.0.0
@ 2017-03-01 23:27 Daniel Bünzli
  2017-03-01 23:33 ` SP
  0 siblings, 1 reply; 4+ messages in thread
From: Daniel Bünzli @ 2017-03-01 23:27 UTC (permalink / raw)
  To: OCaml List

Hello,  

It's my pleasure to announce the release of cmdliner 1.0.0. 

One important notice for all users. The argument converter type will become 
abstract in the next major release, please make sure to migrate your code to use the 
constructors/destructors of the Arg module to minimize breakage in the future.

For the rest all the details are in the release notes [0], here's an abridged view:

* Few breaking API changes but I suspect most users won't be affected.
* Internal sanitization and modularization which hopefully now makes the code 
   readable and will ease further developments. 
* Documentation language sanitization.
* Additions to reduce boilerplate and ease the documentation of your 
  tool (e.g. support for documenting exit statuses). 
* Additions for better composition with Pervasives.exit and the new 
  `result` type of the stdlib.
* End-user error reporting improvements.
* Relicense from BSD3 to ISC.

Cmdliner is an ISC licensed library for the declarative definition of command line interfaces.

Homepage: http://erratique.ch/software/cmdliner
API docs: http://erratique.ch/software/cmdliner/doc

Best, 

Daniel

[0] https://github.com/dbuenzli/cmdliner/blob/v1.0.0/CHANGES.md#v100-2017-03-02-la-forclaz-vs




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Caml-list] [ANN] Cmdliner 1.0.0
  2017-03-01 23:27 [Caml-list] [ANN] Cmdliner 1.0.0 Daniel Bünzli
@ 2017-03-01 23:33 ` SP
  2017-03-01 23:53   ` Daniel Bünzli
  0 siblings, 1 reply; 4+ messages in thread
From: SP @ 2017-03-01 23:33 UTC (permalink / raw)
  To: caml-list

Good work Daniel, thank you. Are there notes anywhere on what and how to
migrate for version 1.0.0, or is it simply a case of using Arg constructors?

-- 
    SP

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Caml-list] [ANN] Cmdliner 1.0.0
  2017-03-01 23:33 ` SP
@ 2017-03-01 23:53   ` Daniel Bünzli
  2017-03-03  9:00     ` SP
  0 siblings, 1 reply; 4+ messages in thread
From: Daniel Bünzli @ 2017-03-01 23:53 UTC (permalink / raw)
  To: SP; +Cc: caml-list

On Thursday, 2 March 2017 at 00:33, SP wrote:
> Good work Daniel, thank you. Are there notes anywhere on what and how to
> migrate for version 1.0.0, or is it simply a case of using Arg constructors?

Mostly yes, you are only affected if you defined your own argument converters and the type system won't bark in this release. The shortest fix is to wrap existing parser-printer pairs with Arg.pconv [0].

A few projects are affected by the addition of the `Blocks case in the Manpage.block type [1]. 

This should mostly be it --- higher-order users may be affected by the addition of optional arguments to some other functions though (e.g. Term.info).

Best, 

Daniel

[0] http://erratique.ch/software/cmdliner/doc/Cmdliner.Arg.html#VALpconv
[1] http://erratique.ch/software/cmdliner/doc/Cmdliner.Manpage.html#TYPEblock





^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [Caml-list] [ANN] Cmdliner 1.0.0
  2017-03-01 23:53   ` Daniel Bünzli
@ 2017-03-03  9:00     ` SP
  0 siblings, 0 replies; 4+ messages in thread
From: SP @ 2017-03-03  9:00 UTC (permalink / raw)
  To: caml-list

Thank you.

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2017-03-03  9:00 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-03-01 23:27 [Caml-list] [ANN] Cmdliner 1.0.0 Daniel Bünzli
2017-03-01 23:33 ` SP
2017-03-01 23:53   ` Daniel Bünzli
2017-03-03  9:00     ` SP

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).