Minor update to installation procedure
See full changelog
Oops, we went looking but didn't find the changelog for this release 🙈
Official stable release announcements and updates from the OCaml compiler, OCaml infrastructure and the OCaml Platform Tools.
Minor update to installation procedure
Oops, we went looking but didn't find the changelog for this release 🙈
This release also marks the apparition of a proper opam install script.
backend:
documentation:
emacs:
vim:

Most package managers support some pin functionality to ensure that a given package remains at a particular version without being upgraded. The stable OPAM 1.1 already supported this by allowing any existing package to be pinned to a target, which could be a specific released version, a local filesystem path, or a remote version-controlled repository.
However, the OPAM 1.1 pinning workflow only lets you pin packages that already exist in your OPAM repositories. To declare a new package, you had to go through creating a local repository, registering it in OPAM, and adding your package definition there. That workflow, while reasonably clear, required the user to know about the repository format and the configuration of an internal repository in OPAM before actually getting to writing a package. Besides, you were on your own for writing the package definition, and the edit-test loop wasn't as friendly as it could have been.
A natural, simpler workflow emerged from allowing users to pin new package names that don't yet exist in an OPAM repository:
opam pin add in the development source treeTo make it even easier, OPAM can now interactively help you write the package definition, and you can test your updates with a single command. This blog post explains this new OPAM 1.2 functionality in more detail; you may also want to check out the new Packaging tutorial relying on this workflow.
For illustration purposes in this post I'll use a tiny tool that I wrote some time ago and never released: ocp-reloc. It's a simple binary that fixes up the headers of OCaml bytecode files to make them relocatable, which I'd like to release into the public OPAM repository.
The command opam pin add <name> <target> pins package <name> to
<target>. We're interested in pinning the ocp-reloc package
name to the project's source directory.
cd ocp-reloc
opam pin add ocp-reloc .
If ocp-reloc were an existing package, the metadata would be fetched from
the package description in the OPAM repositories. Since the package doesn't yet exist,
OPAM 1.2 will instead prompt for on-the-fly creation:
Package ocp-reloc does not exist, create as a NEW package ? [Y/n] y
ocp-reloc is now path-pinned to ~/src/ocp-reloc
NOTE: if you are using beta4, you may get a version-control-pin instead, because we added auto-detection of version-controlled repos. This turned out to be confusing (issue #1582), because your changes wouldn't be reflected until you commit, so this has been reverted in favor of a warning. Add the
--kind pathoption to make sure that you get a path-pin.
Now your package still needs some kind of definition for OPAM to acknowledge it;
that's where templates kick in, the above triggering an editor with a pre-filled
opam file that you just have to complete. This not only saves time in
looking up the documentation, it also helps getting consistent package
definitions, reduces errors, and promotes filling in optional but recommended
fields (homepage, etc.).
opam-version: "1.2"
name: "ocp-reloc"
version: "0.1"
maintainer: "Louis Gesbert <louis.gesbert@ocamlpro.com>"
authors: "Louis Gesbert <louis.gesbert@ocamlpro.com>"
homepage: ""
bug-reports: ""
license: ""
build: [
["./configure" "--prefix=%{prefix}%"]
[make]
]
install: [make "install"]
remove: ["ocamlfind" "remove" "ocp-reloc"]
depends: "ocamlfind" {build}
After adding some details (most importantly the dependencies and
build instructions), I can just save and exit. Much like other system tools
such as visudo, it checks for syntax errors immediately:
[ERROR] File "/home/lg/.opam/4.01.0/overlay/ocp-reloc/opam", line 13, character 35-36: '.' is not a valid token.
Errors in /home/lg/.opam/4.01.0/overlay/ocp-reloc/opam, retry editing ? [Y/n]
You probably want to try your brand new package right away, so
OPAM's default action is to try and install it (unless you specified -n):
ocp-reloc needs to be installed.
The following actions will be performed:
- install cmdliner.0.9.5 [required by ocp-reloc]
- install ocp-reloc.0.1*
=== 1 to install ===
Do you want to continue ? [Y/n]
I usually don't get it working the first time around, but opam pin edit ocp-reloc and opam install ocp-reloc -v can be used to edit and retry until
it does.
How do you keep working on your project as you edit the source code, now that you are installing through OPAM? This is as simple as:
opam upgrade ocp-reloc
This will pick up changes from your source repository and reinstall any packages
that are dependent on ocp-reloc as well, if any.
So far, we've been dealing with the metadata locally used by your OPAM
installation, but you'll probably want to share this among developers of your
project even if you're not releasing anything yet. OPAM takes care of this
by prompting you to save the opam file back to your source tree, where
you can commit it directly into your code repository.
cd ocp-reloc
git add opam
git commit -m 'Add OPAM metadata'
git push
The above information is sufficient to use OPAM locally to integrate new code into an OPAM installation. Let's look at how other developers can share this metadata.
If another developer wants to pick up ocp-reloc, they can directly use
your existing metadata by cloning a copy of your repository and issuing their
own pin.
git clone git://github.com/OCamlPro/ocp-reloc.git
opam pin add ocp-reloc/
Even specifying the package name is optional since this is documented in
ocp-reloc/opam. They can start hacking, and if needed use opam pin edit to
amend the opam file too. No need for a repository, no need to share anything more than a
versioned opam file within your project.
We have been focusing on an unreleased package, but the same
functionality is also of great help in handling existing packages, whether you
need to quickly hack into them or are just curious. Let's consider how to
modify the omd Markdown library.
opam source omd --pin
cd omd.0.9.7
...patch...
opam upgrade omd
The new opam source command will clone the source code of the library you
specify, and the --pin option will also pin it locally to ensure it is used
in preference to all other versions. This will also take care of recompiling
any installed packages that are dependent on omd using your patched version
so that you notice any issues right away.
There's a new OPAM field available in 1.2 called
dev-repo. If you specify this in your metadata, you can directly pin to the upstream repository viaopam source --dev-repo --pin.
If the upstream repository for the package contains an opam file, that file will be picked up
in preference to the one from the OPAM repository as soon as you pin the package.
The idea is to have:
opam file that is versioned along with your source code
(and thus accurately tracks the latest dependencies for your package).opam file that is published on the OPAM repository and can
be updated independently without making a new release of the source code.How to get from the former to the latter will be the subject of another post! In the meantime, all users of the beta are welcome to share their experience and thoughts on the new workflow on the bug tracker.
backend:
emacs:
C-c l previously bound to merlin-useC-c r previously bound to merlin-restart-processC-c t previously bound to merlin-type-exprC-<up> and C-<down> as these already have a
meaning in emacs ( #129 )
They were bound to merlin-type-enclosing-go-up and
merlin-type-enclosing-go-down respectively.extensions:
vim:
Async_core to
Async_kernel#load_rec the same way as #loadWe are proud to announce that OPAM 1.1.1 has just been released.
This minor release features mostly stability and UI/doc improvements over
OPAM 1.1.0, but also focuses on improving the API and tools to be a better
base for the platform (functions for opam-doc, interface with tools like
opamfu and opam-installer). Lots of bigger changes are in the works, and
will be merged progressively after this release.
Installation instructions are available on the wiki.
Note that some packages may take a few days until they get out of the pipeline. If you're eager to get 1.1.1, either use our binary installer or compile from source.
The 'official' package repository is now hosted at opam.ocaml.org, synchronised with the Git repository at http://github.com/ocaml/opam-repository, where you can contribute new packages descriptions. Those are under a CC0 license, a.k.a. public domain, to ensure they will always belong to the community.
Thanks to all of you who have helped build this repository and made OPAM such a success.
From the changelog:
opam-admin make <packages> -r (#990)opam-admin depexts (#997)OpamSolver.empty_universe for flexible universe instantiation (#1033)OpamFormula.eval_relop and OpamFormula.check_relop (#1042)OpamCompiler.compare to match Pervasives.compare (#1042)OpamCompiler.eval_relop (#1042)OpamPackage.Name.compare (#1046)version_constraint and version_formula to OpamFormula (#1046)info an alias for show and added the alias
uninstall (#944)opam init --root=<relative path> (#1047)opam info (#1052).install files usable outside of opam (#1026)--resolve option to opam-admin make that builds just the archives you need for a specific installation (#1031)which by a more portable call (#1061)opam config report to help with bug reports (#1034)opam upgrade <pkg> (#1001)opam init to a non-empty root directory (#974)backend:
emacs:
extensions
vim:
-require command line argument to specify packages on the
command line$OCAML_TOPLEVEL_PATH/autoload at
startup. Can be disabled with autoload: false in ~/.utoprc or
-no-autoload.#typeof to values and modules. Thanks to Thomas Refis for
this feature#utop_prompt_XXX#require when passing multiple packages# to $ to match the standard
toplevelUTop.show_box to allow one to hide the completion
bar_. This can be disabled with
UTop.set_hide_reserved false.Enter in the middle of a comment-short-paths options for OCaml >= 4.01.0
(and make it the default)Toplooputop-fullOops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
Oops, we went looking but didn't find the changelog for this release 🙈
After a while staged as RC, we are proud to announce the final release of OPAM 1.1.0!
Thanks again to those who have helped testing and fixing the last few issues.
The repository format has been improved with incompatible new features; to account for this, the new repository is now hosted at [opam.ocaml.org][], and the legacy repository at [opam.ocamlpro.com][] is kept to support OPAM 1.0 installations, but is unlikely to benefit from many package updates. Migration to [opam.ocaml.org][] will be done automatically as soon as you upgrade your OPAM version.
You're still free, of course, to use any third-party repositories instead or in addition.
NOTE: When switching from 1.0, the internal state will need to be upgraded.
THIS PROCESS CANNOT BE REVERTED. We have tried hard to make it fault-
resistant, but failures might happen. In case you have precious data in your
~/.opam folder, it is advised to backup that folder before you upgrade
to 1.1.0.
Using the binary installer:
Using the .deb packages from Anil's PPA (binaries are [currently syncing][1]): add-apt-repository ppa:avsm/ppa apt-get update sudo apt-get install opam
For OSX users, the homebrew package will be updated shortly.
or build it from sources at :
OPAM is a source-based package manager for OCaml. It supports multiple simultaneous compiler installations, flexible package constraints, and a Git-friendly development workflow. OPAM is edited and maintained by OCamlPro, with continuous support from OCamlLabs and the community at large (including its main industrial users such as Jane-Street and Citrix).
The 'official' package repository is now hosted at [opam.ocaml.org][], synchronised with the Git repository at [http://github.com/ocaml/opam-repository][repo], where you can contribute new packages descriptions. Those are under a CC0 license, a.k.a. public domain, to ensure they will always belong to the community.
Thanks to all of you who have helped build this repository and made OPAM such a success.
Too many to list here, see https://raw.github.com/OCamlPro/opam/1.1.0/CHANGES
For packagers, some new fields have appeared in the OPAM description format:
depexts provides facilities for dealing with system (non ocaml) dependenciesmessages, post-messages can be used to notify the user eg. of licensing information,
or help her troobleshoot at package installation.available supersedes ocaml-version and os constraints, and can contain
more expressive formulasAlso, we have integrated the main package repository with Travis, which will help us to improve the quality of contributions (see Anil's post).
documentation:
emacs:
vim:
backend:
documentation:
emacs
Minor release, but merlin is now compatible with ocaml versions > 4.00.1. The only noticeable changes since 1.3 is the use of short paths even with version 4.00.1 of ocaml.
Oops, we went looking but didn't find the changelog for this release 🙈
backend:
emacs:
extensions:
misc:
vim:
I am very happy to announce the first official release of OPAM!
Many of you already know and use OPAM so I won't be long. Please read http://www.ocamlpro.com/blog/2013/01/17/opam-beta.html for a longer description.
1.0.0 fixes many bugs and add few new features to the previously announced beta-release.
The most visible new feature, which should be useful for beginners with
OCaml and OPAM, is an auto-configuration tool. This tool easily enables all
the features of OPAM (auto-completion, fix the loading of scripts for the
toplevel, opam-switch-eval alias, etc). This tool runs interactively on each
opam init invocation. If you don't like OPAM to change your configuration
files, use opam init --no-setup. If you trust the tool blindly, use
opam init --auto-setup. You can later review the setup by doing
opam config setup --list and call the tool again using opam config setup
(and you can of course manually edit your ~/.profile (or ~/.zshrc for zsh
users), ~/.ocamlinit and ~/.opam/opam-init/*).
Please report:
Packages for Debian and OSX (at least homebrew) should follow shortly and I'm looking for volunteers to create and maintain rpm packages. The binary installer is up-to-date for Linux and Darwin 64-bit architectures, the 32-bit version for Linux should arrive shortly.
If you want to build from sources, the full archive (including dependencies) is available here:
http://www.ocamlpro.com/pub/opam-full-latest.tar.gz
If you are upgrading from 0.9.* you won't have anything special to do apart
installing the new binary. You can then update your package metadata by
running opam update. If you want to use the auto-setup feature, remove the
"eval opam config env line you have previously added in your ~/.profile
and run opam config setup --all.
So everything should be fine. But you never know ... so if something goes horribly wrong in the upgrade process (of if your are upgrading from an old version of OPAM) you can still trash your ~/.opam, manually remove what OPAM added in your ~/.profile (~/.zshrc for zsh users) and ~/.ocamlinit, and start again from scratch.
Great success on github. Thanks everybody for the great contributions!
https://github.com/OCamlPro/opam: +2000 commits, 26 contributors https://github.com/OCamlPro/opam-repository: +1700 commits, 75 contributors, 370+ packages
on http://opam.ocamlpro.com/ +400 unique visitor per week, 15k 'opam update' per week +1300 unique visitor per month, 55k 'opam update' per month 3815 unique visitor since the alpha release
The full change-log since the beta release in January:
1.0.0 [Mar 2013]
0.9.6 [Mar 2013]
~/.profile when using dash (eg. in Debian/Ubuntu)0.9.5 [Mar 2013]
opam remove <pkg> --keep-build-dir keeps the folder if a source archive is extractedopam config exec "CMD ARG1 ... ARGn" --switch=SWITCH to execute a command in a subshellopam update wrt. pinned packagesopam config setup)~/.ocamlinit when running opam init0.9.4 [Feb 2013]
-atype instead of which to detect existing commands)depends and depopts fields in opam infoopam info pkg.version shows the metadata for this given package versiondoc fields in .install filesopam list now only shows installable packages0.9.3 [Feb 2013]
0.9.2 [Jan 2013]
opam repo remove repo-nameopam config envopam-foo scripts (which can be called using opam foo)0.9.1 [Jan 2013]