OCaml - Revision history

Pigs: put languages on the bottom of the page

2025-05-17T16:59:13Z

put languages on the bottom of the page

← Older revision		Revision as of 16:59, 17 May 2025
Line 18:		Line 18:
	#!nix-shell --pure -i ocaml -p ocaml		#!nix-shell --pure -i ocaml -p ocaml
	*)		*)

	~~[[Category:Languages]]~~

	print_string "Hello world! 🚀 \n";;		print_string "Hello world! 🚀 \n";;
Line 78:		Line 76:

	More details: https://github.com/NixOS/nixpkgs/pull/53357#issuecomment-451727433		More details: https://github.com/NixOS/nixpkgs/pull/53357#issuecomment-451727433

			[[Category:Languages]]

Pigs: Add category languages

2025-05-17T16:58:18Z

Add category languages

← Older revision		Revision as of 16:58, 17 May 2025
Line 18:		Line 18:
	#!nix-shell --pure -i ocaml -p ocaml		#!nix-shell --pure -i ocaml -p ocaml
	*)		*)

			[[Category:Languages]]

	print_string "Hello world! 🚀 \n";;		print_string "Hello world! 🚀 \n";;

Mic92: overrideScope

2024-07-12T12:04:41Z

overrideScope

← Older revision		Revision as of 12:04, 12 July 2024
Line 67:		Line 67:
	=== Custom version ===		=== Custom version ===

	So as to get the set of OCaml libraries built with/for a custom version of the OCaml compiler, e.g., to enable '''flambda''' support, you may use the '''ocamlPackages.overrideScope'''' function:		So as to get the set of OCaml libraries built with/for a custom version of the OCaml compiler, e.g., to enable '''flambda''' support, you may use the '''ocamlPackages.overrideScope''' function:

	<syntaxHighlight lang=nix>		<syntaxHighlight lang=nix>
	ocamlPackagesFlambda = ocamlPackages.overrideScope' (self: super: {		ocamlPackagesFlambda = ocamlPackages.overrideScope (self: super: {
	ocaml = super.ocaml.override { flambdaSupport = true; };		ocaml = super.ocaml.override { flambdaSupport = true; };
	});		});

imported>Samuela at 22:17, 5 April 2021

2021-04-05T22:17:06Z

← Older revision		Revision as of 22:17, 5 April 2021
Line 10:		Line 10:

	This hook also sets the '''CAML_LD_LIBRARY_PATH''' environment variable that is used for locating the dynamically loaded shared libraries (aka stublibs).		This hook also sets the '''CAML_LD_LIBRARY_PATH''' environment variable that is used for locating the dynamically loaded shared libraries (aka stublibs).

			== Scripting with OCaml ==
			OCaml can be used in nix-shell scripts as follows:
			<syntaxHighlight lang=ocaml>
			#!/usr/bin/env nix-shell
			(*
			#!nix-shell --pure -i ocaml -p ocaml
			*)

			print_string "Hello world! 🚀 \n";;
			</syntaxHighlight>

	== Using Emacs ==		== Using Emacs ==

imported>Vbgl: /* Specific version of the OCaml compiler */ flambda

2019-01-06T11:32:29Z

Specific version of the OCaml compiler: flambda

← Older revision		Revision as of 11:32, 6 January 2019
Line 53:		Line 53:

	Various versions of the '''ocamlPackage''' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.		Various versions of the '''ocamlPackage''' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.

			=== Custom version ===

			So as to get the set of OCaml libraries built with/for a custom version of the OCaml compiler, e.g., to enable '''flambda''' support, you may use the '''ocamlPackages.overrideScope'''' function:

			<syntaxHighlight lang=nix>
			ocamlPackagesFlambda = ocamlPackages.overrideScope' (self: super: {
			ocaml = super.ocaml.override { flambdaSupport = true; };
			});
			</syntaxHighlight>

			More details: https://github.com/NixOS/nixpkgs/pull/53357#issuecomment-451727433

imported>Vbgl: fix markup

2018-06-19T06:07:00Z

fix markup

← Older revision		Revision as of 06:07, 19 June 2018
Line 52:		Line 52:
	== Specific version of the OCaml compiler ==		== Specific version of the OCaml compiler ==

	Various versions of the '''ocamlPackage'' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.		Various versions of the '''ocamlPackage''' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.

imported>Mic92: syntax highlighting

2018-06-14T18:13:22Z

syntax highlighting

← Older revision		Revision as of 18:13, 14 June 2018
Line 18:		Line 18:
	Emacs must be configured to be able to find this package: you may need to add a line like this to your '''.emacs''' file, somewhere between <code>(require 'package)</code> and <code>(package-initialize)</code>:		Emacs must be configured to be able to find this package: you may need to add a line like this to your '''.emacs''' file, somewhere between <code>(require 'package)</code> and <code>(package-initialize)</code>:

	(add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")		<syntaxHighlight lang=emacs>
			(add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")
			</syntaxHighlight>

	There is some more documentation in the [https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/emacs-packages.nix nixpkgs sources].		There is some more documentation in the [https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/emacs-packages.nix nixpkgs sources].
Line 28:		Line 30:
	To configure Emacs and enable the merlin mode, add the following to your '''.emacs''':		To configure Emacs and enable the merlin mode, add the following to your '''.emacs''':

	(add-to-list 'load-path "~/.nix-profile/share/emacs/site-lisp")		<syntaxHighlight lang=emacs>
	(require 'merlin)		(add-to-list 'load-path "~/.nix-profile/share/emacs/site-lisp")
	(add-hook 'tuareg-mode-hook 'merlin-mode t)		(require 'merlin)
			(add-hook 'tuareg-mode-hook 'merlin-mode t)
			</syntaxHighlight>

	Also, a specific variable ('''merlin-command''') of the merlin mode must be overridden (its default is '''opam'''):		Also, a specific variable ('''merlin-command''') of the merlin mode must be overridden (its default is '''opam'''):

	(custom-set-variables		<syntaxHighlight lang=emacs>
	'(merlin-command "ocamlmerlin")		(custom-set-variables
	)		'(merlin-command "ocamlmerlin")
			)
			</syntaxHighlight>

	A useful complement to merlin is [https://www.typerex.org/ocp-indent.html '''ocp-indent'''], a customizable tool to indent OCaml code. It can be installed using <code>nix-env -iA nixpkgs.ocamlPackages.ocpIndent</code>. To enable it in Emacs, don’t forget to add the following line to your '''.emacs''':		A useful complement to merlin is [https://www.typerex.org/ocp-indent.html '''ocp-indent'''], a customizable tool to indent OCaml code. It can be installed using <code>nix-env -iA nixpkgs.ocamlPackages.ocpIndent</code>. To enable it in Emacs, don’t forget to add the following line to your '''.emacs''':

	(require 'ocp-indent)		<syntaxHighlight lang=emacs>
			(require 'ocp-indent)
			</syntaxHighlight>

	== Specific version of the OCaml compiler ==		== Specific version of the OCaml compiler ==

	Various versions of the '''ocamlPackage'' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.		Various versions of the '''ocamlPackage'' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.

imported>Mic92: fix markup

2018-06-14T18:11:37Z

fix markup

← Older revision		Revision as of 18:11, 14 June 2018
Line 3:		Line 3:
	== Findlib, ocamlfind ==		== Findlib, ocamlfind ==

	OCaml libraries are usually located using [[http://projects.camlcity.org/projects/findlib.html findlib]] and the associated '''ocamlfind''' tool. These tools are found under the '''ocamlPackages.findlib''' attribute and rely on the '''OCAMLPATH''' environment variable.		OCaml libraries are usually located using [http://projects.camlcity.org/projects/findlib.html findlib] and the associated '''ocamlfind''' tool. These tools are found under the '''ocamlPackages.findlib''' attribute and rely on the '''OCAMLPATH''' environment variable.

	A hook in the '''findlib''' package will automatically populate this variable with the paths to the other libraries. For instance, when starting a shell with		A hook in the '''findlib''' package will automatically populate this variable with the paths to the other libraries. For instance, when starting a shell with
Line 13:		Line 13:
	== Using Emacs ==		== Using Emacs ==

	[[https://github.com/ocaml/tuareg Tuareg]] is an Emacs OCaml mode. It can be installed with		[https://github.com/ocaml/tuareg Tuareg] is an Emacs OCaml mode. It can be installed with
	<code>nix-env -iA nixpkgs.emacsPackagesNg.tuareg</code>.		<code>nix-env -iA nixpkgs.emacsPackagesNg.tuareg</code>.

Line 20:		Line 20:
	(add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")		(add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")

	There is some more documentation in the [[https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/emacs-packages.nix nixpkgs sources]].		There is some more documentation in the [https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/emacs-packages.nix nixpkgs sources].

	[[https://github.com/ocaml/merlin Merlin]] provides additional functionality to Emacs. It can be installed through <code>nix-env -iA nixpkgs.ocamlPackages.merlin</code>.		[https://github.com/ocaml/merlin Merlin] provides additional functionality to Emacs. It can be installed through <code>nix-env -iA nixpkgs.ocamlPackages.merlin</code>.

	Beware that merlin is specific to one particular version of OCaml (it won’t work correctly with a compiler of a different version).		Beware that merlin is specific to one particular version of OCaml (it won’t work correctly with a compiler of a different version).
Line 38:		Line 38:
	)		)

	A useful complement to merlin is [[https://www.typerex.org/ocp-indent.html '''ocp-indent''']], a customizable tool to indent OCaml code. It can be installed using <code>nix-env -iA nixpkgs.ocamlPackages.ocpIndent</code>. To enable it in Emacs, don’t forget to add the following line to your '''.emacs''':		A useful complement to merlin is [https://www.typerex.org/ocp-indent.html '''ocp-indent'''], a customizable tool to indent OCaml code. It can be installed using <code>nix-env -iA nixpkgs.ocamlPackages.ocpIndent</code>. To enable it in Emacs, don’t forget to add the following line to your '''.emacs''':

	(require 'ocp-indent)		(require 'ocp-indent)

imported>Vbgl: A few words about OCaml

2018-06-14T16:46:47Z

A few words about OCaml

New page

Most packages related to OCaml, in particular the OCaml compiler and many libraries, belong to the '''ocamlPackages''' attribute set of nixpkgs.

== Findlib, ocamlfind ==

OCaml libraries are usually located using [[http://projects.camlcity.org/projects/findlib.html findlib]] and the associated '''ocamlfind''' tool. These tools are found under the '''ocamlPackages.findlib''' attribute and rely on the '''OCAMLPATH''' environment variable.

A hook in the '''findlib''' package will automatically populate this variable with the paths to the other libraries. For instance, when starting a shell with
<code>nix-shell --packages ocamlPackages.findlib ocamlPackages.batteries</code>
will set the '''OCAMLPATH''' variable so that '''ocamlfind''' can locate the '''batteries''' library.

This hook also sets the '''CAML_LD_LIBRARY_PATH''' environment variable that is used for locating the dynamically loaded shared libraries (aka stublibs).

== Using Emacs ==

[[https://github.com/ocaml/tuareg Tuareg]] is an Emacs OCaml mode. It can be installed with
<code>nix-env -iA nixpkgs.emacsPackagesNg.tuareg</code>.

Emacs must be configured to be able to find this package: you may need to add a line like this to your '''.emacs''' file, somewhere between <code>(require 'package)</code> and <code>(package-initialize)</code>:

(add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")

There is some more documentation in the [[https://github.com/NixOS/nixpkgs/blob/master/pkgs/top-level/emacs-packages.nix nixpkgs sources]].

[[https://github.com/ocaml/merlin Merlin]] provides additional functionality to Emacs. It can be installed through <code>nix-env -iA nixpkgs.ocamlPackages.merlin</code>.

Beware that merlin is specific to one particular version of OCaml (it won’t work correctly with a compiler of a different version).

To configure Emacs and enable the merlin mode, add the following to your '''.emacs''':

(add-to-list 'load-path "~/.nix-profile/share/emacs/site-lisp")
(require 'merlin)
(add-hook 'tuareg-mode-hook 'merlin-mode t)

Also, a specific variable ('''merlin-command''') of the merlin mode must be overridden (its default is '''opam'''):

(custom-set-variables
'(merlin-command "ocamlmerlin")
)

A useful complement to merlin is [[https://www.typerex.org/ocp-indent.html '''ocp-indent''']], a customizable tool to indent OCaml code. It can be installed using <code>nix-env -iA nixpkgs.ocamlPackages.ocpIndent</code>. To enable it in Emacs, don’t forget to add the following line to your '''.emacs''':

(require 'ocp-indent)

== Specific version of the OCaml compiler ==

Various versions of the '''ocamlPackage'' attribute set are available, corresponding to various versions of OCaml. For instance, the attribute set '''ocaml-ng.ocamlPackages_4_04''' contains the OCaml compiler at version 4.04 and OCaml libraries compiled with that particular compiler.