diff options
| author | Alyssa Ross <hi@alyssa.is> | 2022-01-03 23:55:00 +0000 |
|---|---|---|
| committer | Alyssa Ross <hi@alyssa.is> | 2022-02-19 11:03:39 +0000 |
| commit | f4cf97a04cd5d0b86aa46baec9fb228a8f671c03 (patch) | |
| tree | 28192415ff39a661d0001563bf81cc93fa25d16d /nixpkgs/doc/languages-frameworks/ocaml.section.md | |
| parent | f8422837c9bde058e8f2de37702e7e94b2226040 (diff) | |
| parent | 18c84ea816348e2a098390101b92d1e39a9dbd45 (diff) | |
| download | nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar.gz nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar.bz2 nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar.lz nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar.xz nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.tar.zst nixlib-f4cf97a04cd5d0b86aa46baec9fb228a8f671c03.zip | |
Merge commit '18c84ea816348e2a098390101b92d1e39a9dbd45'
Conflicts: nixpkgs/nixos/modules/misc/documentation.nix nixpkgs/pkgs/applications/networking/browsers/firefox/packages.nix nixpkgs/pkgs/applications/window-managers/sway/default.nix nixpkgs/pkgs/build-support/rust/build-rust-package/default.nix nixpkgs/pkgs/development/go-modules/generic/default.nix nixpkgs/pkgs/development/interpreters/ruby/default.nix nixpkgs/pkgs/development/interpreters/ruby/patchsets.nix nixpkgs/pkgs/development/libraries/boehm-gc/7.6.6.nix nixpkgs/pkgs/development/python-modules/django-mailman3/default.nix nixpkgs/pkgs/servers/mail/mailman/web.nix nixpkgs/pkgs/top-level/aliases.nix nixpkgs/pkgs/top-level/all-packages.nix nixpkgs/pkgs/top-level/impure.nix
Diffstat (limited to 'nixpkgs/doc/languages-frameworks/ocaml.section.md')
| -rw-r--r-- | nixpkgs/doc/languages-frameworks/ocaml.section.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/nixpkgs/doc/languages-frameworks/ocaml.section.md b/nixpkgs/doc/languages-frameworks/ocaml.section.md index 5ffc23173d6d..d266a032268c 100644 --- a/nixpkgs/doc/languages-frameworks/ocaml.section.md +++ b/nixpkgs/doc/languages-frameworks/ocaml.section.md @@ -1,5 +1,31 @@ # OCaml {#sec-language-ocaml} +## User guide {#sec-language-ocaml-user-guide} + +OCaml libraries are available in attribute sets of the form `ocaml-ng.ocamlPackages_X_XX` where X is to be replaced with the desired compiler version. For example, ocamlgraph compiled with OCaml 4.12 can be found in `ocaml-ng.ocamlPackages_4_12.ocamlgraph`. The compiler itself is also located in this set, under the name `ocaml`. + +If you don't care about the exact compiler version, `ocamlPackages` is a top-level alias pointing to a recent version of OCaml. + +OCaml applications are usually available top-level, and not inside `ocamlPackages`. Notable exceptions are build tools that must be built with the same compiler version as the compiler you intend to use like `dune` or `ocaml-lsp`. + +To open a shell able to build a typical OCaml project, put the dependencies in `buildInputs` and add `ocamlPackages.ocaml` and `ocamlPackages.findlib` to `nativeBuildInputs` at least. +For example: +```nix +let + pkgs = import <nixpkgs> {}; + # choose the ocaml version you want to use + ocamlPackages = pkgs.ocaml-ng.ocamlPackages_4_12; +in +pkgs.mkShell { + # build tools + nativeBuildInputs = with ocamlPackages; [ ocaml findlib dune_2 ocaml-lsp ]; + # dependencies + buildInputs = with ocamlPackages; [ ocamlgraph ]; +} +``` + +## Packaging guide {#sec-language-ocaml-packaging} + OCaml libraries should be installed in `$(out)/lib/ocaml/${ocaml.version}/site-lib/`. Such directories are automatically added to the `$OCAMLPATH` environment variable when building another package that depends on them or when opening a `nix-shell`. Given that most of the OCaml ecosystem is now built with dune, nixpkgs includes a convenience build support function called `buildDunePackage` that will build an OCaml package using dune, OCaml and findlib and any additional dependencies provided as `buildInputs` or `propagatedBuildInputs`. |