2016-02-18 07:11:59 -08:00
|
|
|
.\"**************************************************************************
|
|
|
|
.\"* *
|
|
|
|
.\"* OCaml *
|
|
|
|
.\"* *
|
|
|
|
.\"* Xavier Leroy, projet Cristal, INRIA Rocquencourt *
|
|
|
|
.\"* *
|
|
|
|
.\"* Copyright 1996 Institut National de Recherche en Informatique et *
|
|
|
|
.\"* en Automatique. *
|
|
|
|
.\"* *
|
|
|
|
.\"* All rights reserved. This file is distributed under the terms of *
|
|
|
|
.\"* the GNU Lesser General Public License version 2.1, with the *
|
|
|
|
.\"* special exception on linking described in the file LICENSE. *
|
|
|
|
.\"* *
|
|
|
|
.\"**************************************************************************
|
2011-07-27 07:17:02 -07:00
|
|
|
.\"
|
1996-05-10 06:27:26 -07:00
|
|
|
.TH OCAMLC 1
|
1995-11-02 08:54:37 -08:00
|
|
|
|
|
|
|
.SH NAME
|
2011-04-26 05:16:50 -07:00
|
|
|
ocamlc \- The OCaml bytecode compiler
|
1995-11-02 08:54:37 -08:00
|
|
|
|
|
|
|
.SH SYNOPSIS
|
1996-04-30 07:53:58 -07:00
|
|
|
.B ocamlc
|
1995-11-02 08:54:37 -08:00
|
|
|
[
|
2008-09-11 09:16:27 -07:00
|
|
|
.I options
|
1995-11-02 08:54:37 -08:00
|
|
|
]
|
|
|
|
.I filename ...
|
|
|
|
|
1999-02-25 06:25:54 -08:00
|
|
|
.B ocamlc.opt
|
2008-09-11 09:16:27 -07:00
|
|
|
[
|
|
|
|
.I options
|
|
|
|
]
|
|
|
|
.I filename ...
|
1999-02-25 06:25:54 -08:00
|
|
|
|
1995-11-02 08:54:37 -08:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
2011-04-26 05:16:50 -07:00
|
|
|
The OCaml bytecode compiler
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlc (1)
|
2011-06-15 05:24:26 -07:00
|
|
|
compiles OCaml source files to bytecode object files and links
|
1995-11-02 08:54:37 -08:00
|
|
|
these object files to produce standalone bytecode executable files.
|
|
|
|
These executable files are then run by the bytecode interpreter
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlrun (1).
|
1995-11-02 08:54:37 -08:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
The
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlc (1)
|
1995-11-02 08:54:37 -08:00
|
|
|
command has a command-line interface similar to the one of
|
2004-07-13 05:25:21 -07:00
|
|
|
most C compilers. It accepts several types of arguments and processes them
|
2016-02-09 06:38:21 -08:00
|
|
|
sequentially, after all options have been processed:
|
1995-11-02 08:54:37 -08:00
|
|
|
|
|
|
|
Arguments ending in .mli are taken to be source files for
|
|
|
|
compilation unit interfaces. Interfaces specify the names exported by
|
|
|
|
compilation units: they declare value names with their types, define
|
|
|
|
public data types, declare abstract data types, and so on. From the
|
2008-09-11 09:16:27 -07:00
|
|
|
file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.mli,
|
2008-09-11 09:16:27 -07:00
|
|
|
the
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlc (1)
|
1995-11-02 08:54:37 -08:00
|
|
|
compiler produces a compiled interface
|
2008-09-11 09:16:27 -07:00
|
|
|
in the file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmi.
|
|
|
|
|
|
|
|
Arguments ending in .ml are taken to be source files for compilation
|
|
|
|
unit implementations. Implementations provide definitions for the
|
|
|
|
names exported by the unit, and also contain expressions to be
|
2008-09-11 09:16:27 -07:00
|
|
|
evaluated for their side-effects. From the file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.ml,
|
2008-09-11 09:16:27 -07:00
|
|
|
the
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlc (1)
|
2008-09-11 09:16:27 -07:00
|
|
|
compiler produces compiled object bytecode in the file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmo.
|
2008-09-11 09:16:27 -07:00
|
|
|
|
|
|
|
If the interface file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.mli
|
|
|
|
exists, the implementation
|
|
|
|
.IR x \&.ml
|
|
|
|
is checked against the corresponding compiled interface
|
|
|
|
.IR x \&.cmi,
|
|
|
|
which is assumed to exist. If no interface
|
|
|
|
.IR x \&.mli
|
2008-09-11 09:16:27 -07:00
|
|
|
is provided, the compilation of
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.ml
|
2008-09-11 09:16:27 -07:00
|
|
|
produces a compiled interface file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmi
|
2008-09-11 09:16:27 -07:00
|
|
|
in addition to the compiled object code file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmo.
|
2008-09-11 09:16:27 -07:00
|
|
|
The file
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmi
|
|
|
|
produced
|
|
|
|
corresponds to an interface that exports everything that is defined in
|
2008-09-11 09:16:27 -07:00
|
|
|
the implementation
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.ml.
|
|
|
|
|
|
|
|
Arguments ending in .cmo are taken to be compiled object bytecode. These
|
|
|
|
files are linked together, along with the object files obtained
|
2011-06-15 05:24:26 -07:00
|
|
|
by compiling .ml arguments (if any), and the OCaml standard
|
1995-11-02 08:54:37 -08:00
|
|
|
library, to produce a standalone executable program. The order in
|
|
|
|
which .cmo and.ml arguments are presented on the command line is
|
|
|
|
relevant: compilation units are initialized in that order at
|
|
|
|
run-time, and it is a link-time error to use a component of a unit
|
2008-09-11 09:16:27 -07:00
|
|
|
before having initialized it. Hence, a given
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x \&.cmo
|
2008-09-11 09:16:27 -07:00
|
|
|
file must come before all .cmo files that refer to the unit
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR x .
|
|
|
|
|
|
|
|
Arguments ending in .cma are taken to be libraries of object bytecode.
|
|
|
|
A library of object bytecode packs in a single file a set of object
|
2008-09-11 09:16:27 -07:00
|
|
|
bytecode files (.cmo files). Libraries are built with
|
2008-09-15 07:05:30 -07:00
|
|
|
.B ocamlc\ \-a
|
2008-09-11 09:16:27 -07:00
|
|
|
(see the description of the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-a
|
|
|
|
option below). The object files
|
2008-09-11 09:16:27 -07:00
|
|
|
contained in the library are linked as regular .cmo files (see above),
|
|
|
|
in the order specified when the .cma file was built. The only
|
|
|
|
difference is that if an object file
|
1995-11-02 08:54:37 -08:00
|
|
|
contained in a library is not referenced anywhere in the program, then
|
|
|
|
it is not linked in.
|
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
Arguments ending in .c are passed to the C compiler, which generates
|
|
|
|
a .o object file. This object file is linked with the program if the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
2008-09-11 09:16:27 -07:00
|
|
|
flag is set (see the description of
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
|
|
|
below).
|
|
|
|
|
2004-07-13 05:25:21 -07:00
|
|
|
Arguments ending in .o or .a are assumed to be C object files and
|
2008-09-11 09:16:27 -07:00
|
|
|
libraries. They are passed to the C linker when linking in
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
2008-09-11 09:16:27 -07:00
|
|
|
mode (see the description of
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
|
|
|
below).
|
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
Arguments ending in .so
|
|
|
|
are assumed to be C shared libraries (DLLs). During linking, they are
|
2011-06-15 05:24:26 -07:00
|
|
|
searched for external C functions referenced from the OCaml code,
|
2008-09-11 09:16:27 -07:00
|
|
|
and their names are written in the generated bytecode executable.
|
|
|
|
The run-time system
|
|
|
|
.BR ocamlrun (1)
|
|
|
|
then loads them dynamically at program start-up time.
|
|
|
|
|
|
|
|
The output of the linking phase is a file containing compiled bytecode
|
2011-04-26 05:16:50 -07:00
|
|
|
that can be executed by the OCaml bytecode interpreter:
|
2008-09-11 09:16:27 -07:00
|
|
|
the command
|
|
|
|
.BR ocamlrun (1).
|
|
|
|
If
|
|
|
|
.B caml.out
|
|
|
|
is the name of the file produced by the linking phase, the command
|
|
|
|
.B ocamlrun caml.out
|
|
|
|
.IR arg1 \ \ arg2 \ ... \ argn
|
|
|
|
executes the compiled code contained in
|
|
|
|
.BR caml.out ,
|
|
|
|
passing it as arguments the character strings
|
|
|
|
.I arg1
|
|
|
|
to
|
|
|
|
.IR argn .
|
|
|
|
(See
|
|
|
|
.BR ocamlrun (1)
|
|
|
|
for more details.)
|
|
|
|
|
|
|
|
On most systems, the file produced by the linking
|
|
|
|
phase can be run directly, as in:
|
|
|
|
.B ./caml.out
|
|
|
|
.IR arg1 \ \ arg2 \ ... \ argn .
|
|
|
|
The produced file has the executable bit set, and it manages to launch
|
|
|
|
the bytecode interpreter by itself.
|
|
|
|
|
1999-02-25 06:25:54 -08:00
|
|
|
.B ocamlc.opt
|
|
|
|
is the same compiler as
|
|
|
|
.BR ocamlc ,
|
|
|
|
but compiled with the native-code compiler
|
|
|
|
.BR ocamlopt (1).
|
|
|
|
Thus, it behaves exactly like
|
|
|
|
.BR ocamlc ,
|
|
|
|
but compiles faster.
|
|
|
|
.B ocamlc.opt
|
2011-06-15 05:24:26 -07:00
|
|
|
may not be available in all installations of OCaml.
|
1999-02-25 06:25:54 -08:00
|
|
|
|
1995-11-02 08:54:37 -08:00
|
|
|
.SH OPTIONS
|
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
The following command-line options are recognized by
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlc (1).
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
|
|
|
.B \-a
|
2008-09-11 09:16:27 -07:00
|
|
|
Build a library (.cma file) with the object files (.cmo files) given
|
|
|
|
on the command line, instead of linking them into an executable
|
|
|
|
file. The name of the library must be set with the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-o
|
2008-09-11 09:16:27 -07:00
|
|
|
option.
|
|
|
|
.IP
|
|
|
|
If
|
|
|
|
.BR \-custom , \ \-cclib \ or \ \-ccopt
|
|
|
|
options are passed on the command
|
|
|
|
line, these options are stored in the resulting .cma library. Then,
|
|
|
|
linking with this library automatically adds back the
|
|
|
|
.BR \-custom , \ \-cclib \ and \ \-ccopt
|
|
|
|
options as if they had been provided on the
|
|
|
|
command line, unless the
|
2016-04-17 06:01:07 -07:00
|
|
|
.B \-noautolink
|
2015-02-08 03:18:29 -08:00
|
|
|
option is given. Additionally, a substring
|
|
|
|
.B $CAMLORIGIN
|
|
|
|
inside a
|
|
|
|
.BR \ \-ccopt
|
|
|
|
options will be replaced by the full path to the .cma library,
|
|
|
|
excluding the filename.
|
2012-08-03 03:22:35 -07:00
|
|
|
.B \-absname
|
|
|
|
Show absolute filenames in error messages.
|
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-annot
|
2020-03-13 04:59:34 -07:00
|
|
|
Deprecated since 4.11. Please use
|
|
|
|
.BR \-bin-annot
|
|
|
|
instead.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.B \-bin\-annot
|
|
|
|
Dump detailed information about the compilation (types, bindings,
|
|
|
|
tail-calls, etc) in binary format. The information for file
|
|
|
|
.IR src .ml
|
|
|
|
is put into file
|
|
|
|
.IR src .cmt.
|
|
|
|
In case of a type error, dump
|
|
|
|
all the information inferred by the type-checker before the error.
|
|
|
|
The annotation files produced by
|
|
|
|
.B \-bin\-annot
|
|
|
|
contain more information
|
|
|
|
and are much more compact than the files produced by
|
|
|
|
.BR \-annot .
|
2012-02-19 10:35:30 -08:00
|
|
|
.TP
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-c
|
|
|
|
Compile only. Suppress the linking phase of the
|
|
|
|
compilation. Source code files are turned into compiled files, but no
|
|
|
|
executable file is produced. This option is useful to
|
|
|
|
compile modules separately.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
|
|
|
.BI \-cc \ ccomp
|
|
|
|
Use
|
|
|
|
.I ccomp
|
|
|
|
as the C linker when linking in "custom runtime" mode (see the
|
|
|
|
.B \-custom
|
|
|
|
option) and as the C compiler for compiling .c source files.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
|
|
|
.BI \-cclib\ -l libname
|
2008-09-11 09:16:27 -07:00
|
|
|
Pass the
|
1995-11-02 08:54:37 -08:00
|
|
|
.BI \-l libname
|
2008-09-11 09:16:27 -07:00
|
|
|
option to the C linker when linking in "custom runtime" mode (see the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
2008-09-11 09:16:27 -07:00
|
|
|
option). This causes the given C library to be linked with the program.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.BI \-ccopt \ option
|
|
|
|
Pass the given
|
|
|
|
.I option
|
|
|
|
to the C compiler and linker, when linking in
|
2008-09-11 09:16:27 -07:00
|
|
|
"custom runtime" mode (see the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
|
|
|
option). For instance,
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-ccopt\ \-L dir
|
1995-11-02 08:54:37 -08:00
|
|
|
causes the C linker to search for C libraries in
|
2008-09-11 09:16:27 -07:00
|
|
|
directory
|
1995-11-02 08:54:37 -08:00
|
|
|
.IR dir .
|
2016-02-16 02:33:53 -08:00
|
|
|
.TP
|
|
|
|
.BI \-color \ mode
|
|
|
|
Enable or disable colors in compiler messages (especially warnings and errors).
|
|
|
|
The following modes are supported:
|
|
|
|
|
|
|
|
.B auto
|
2016-02-25 07:22:39 -08:00
|
|
|
use heuristics to enable colors only if the output supports them (an
|
|
|
|
ANSI-compatible tty terminal);
|
2016-02-16 02:33:53 -08:00
|
|
|
|
|
|
|
.B always
|
|
|
|
enable colors unconditionally;
|
|
|
|
|
|
|
|
.B never
|
|
|
|
disable color output.
|
|
|
|
|
|
|
|
The default setting is
|
|
|
|
.B auto,
|
|
|
|
and the current heuristic
|
|
|
|
checks that the "TERM" environment variable exists and is
|
|
|
|
not empty or "dumb", and that isatty(stderr) holds.
|
|
|
|
|
Respect OCAML_COLOR environment variable for deciding whether to use colors
Since 4.03, OCaml supports coloring its messages to standard output and standard
error, depending on the "-color" argument ({always,never,auto}). This commit
adds support for the environment variable "OCAML_COLOR" (which value can as well
be {always,never,auto}).
The command line argument "-color" takes precedence, "OCAML_COLOR" is only
taken into consideration if no "-color" is provided.
The motivation for this is that the user should have control over coloring
OCaml's output messages. OCamlbuild, a widely used build tool executes OCaml
not under a tty (and OCaml does not colorize errors and warnings), which lead
various packages use `color(always)` in their `_tags` files, which breaks with
other (non-interactive) programs (i.e. editor helpers).
Further discussion was done at https://github.com/ocaml/ocamlbuild/issues/87 and
https://github.com/ocaml/ocaml/pull/1098.
2017-03-11 03:38:59 -08:00
|
|
|
The environment variable "OCAML_COLOR" is considered if \-color is not
|
|
|
|
provided. Its values are auto/always/never as above.
|
|
|
|
|
2018-10-19 13:20:30 -07:00
|
|
|
.TP
|
|
|
|
.BI \-error\-style \ mode
|
|
|
|
Control the way error messages and warnings are printed.
|
|
|
|
The following modes are supported:
|
|
|
|
|
|
|
|
.B short
|
|
|
|
only print the error and its location;
|
|
|
|
|
|
|
|
.B contextual
|
|
|
|
like "short", but also display the source code snippet corresponding
|
|
|
|
to the location of the error.
|
|
|
|
|
|
|
|
The default setting is
|
|
|
|
.B contextual.
|
|
|
|
|
|
|
|
The environment variable "OCAML_ERROR_STYLE" is considered if
|
|
|
|
\-error\-style is not provided. Its values are short/contextual as
|
|
|
|
above.
|
|
|
|
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.B \-compat\-32
|
|
|
|
Check that the generated bytecode executable can run on 32-bit
|
|
|
|
platforms and signal an error if it cannot. This is useful when
|
|
|
|
compiling bytecode on a 64-bit machine.
|
|
|
|
.TP
|
2008-09-15 07:05:30 -07:00
|
|
|
.B \-config
|
|
|
|
Print the version number of
|
|
|
|
.BR ocamlc (1)
|
|
|
|
and a detailed summary of its configuration, then exit.
|
|
|
|
.TP
|
ocamlc -config: new -config-var option to print specific configuration variables
The proposed behavior of `-config-var s` is as follows:
- if `s` is an existing configuration variable, print its value as
a string and exit with a success return value (0)
- if `s` is not an existing configuration variable, print nothing
and exit with a failure return value (non-0)
Note that we do not print a newline after the value of the
configuration variable. In particular, if the value is an empty
string, the output is undistinguishable from the output for
non-existing variables, the return value has to be considered instead.
The following alternative behaviors were considered:
- We could print a newline after the configuration value, which
would let users distinguish empty values from non-existing variables
by counting the lines of output, and would also be more pleasant for
users invoking the option from the command-line. However, the way
bash works on Windows means that $(ocamlc -config-var foo) would keep
a trailing \r in its output, and portable scripts would have to use
$(ocamlc -config-var foo | tr -d '\r') instead, which is a pain.
(This issue was pointed out by David Allsopp)
- We could print a message on the error output if the configuration
variable does not exist. This is clearer to a human user, but it is
annoying for scripts if they forget to silence the error output and
get their output mixed with our error messages. The main use of this
new feature is for scripting purposes.
2017-10-14 09:46:58 -07:00
|
|
|
.BI \-config-var
|
|
|
|
Print the value of a specific configuration variable
|
|
|
|
from the
|
|
|
|
.B \-config
|
|
|
|
output, then exit. If the variable does not exist,
|
|
|
|
the exit code is non-zero.
|
|
|
|
.TP
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-custom
|
2008-09-11 09:16:27 -07:00
|
|
|
Link in "custom runtime" mode. In the default linking mode, the
|
1995-11-02 08:54:37 -08:00
|
|
|
linker produces bytecode that is intended to be executed with the
|
2008-09-11 09:16:27 -07:00
|
|
|
shared runtime system,
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlrun (1).
|
1995-11-02 08:54:37 -08:00
|
|
|
In the custom runtime mode, the
|
|
|
|
linker produces an output file that contains both the runtime system
|
|
|
|
and the bytecode for the program. The resulting file is larger, but it
|
2008-09-11 09:16:27 -07:00
|
|
|
can be executed directly, even if the
|
1996-04-30 07:53:58 -07:00
|
|
|
.BR ocamlrun (1)
|
1995-11-02 08:54:37 -08:00
|
|
|
command is not
|
2011-06-15 05:24:26 -07:00
|
|
|
installed. Moreover, the "custom runtime" mode enables linking OCaml
|
2008-09-15 07:12:56 -07:00
|
|
|
code with user-defined C functions.
|
|
|
|
|
|
|
|
Never use the
|
2008-09-11 09:16:27 -07:00
|
|
|
.BR strip (1)
|
|
|
|
command on executables produced by
|
|
|
|
.BR ocamlc\ \-custom ,
|
|
|
|
this would remove the bytecode part of the executable.
|
2017-06-28 05:02:15 -07:00
|
|
|
|
|
|
|
Security warning: never set the "setuid" or "setgid" bits on
|
|
|
|
executables produced by
|
|
|
|
.BR ocamlc\ \-custom ,
|
|
|
|
this would make them vulnerable to attacks.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
2017-05-14 07:44:42 -07:00
|
|
|
.BI \-depend\ ocamldep-args
|
|
|
|
Compute dependencies, as ocamldep would do.
|
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-dllib\ \-l libname
|
|
|
|
Arrange for the C shared library
|
|
|
|
.BI dll libname .so
|
|
|
|
to be loaded dynamically by the run-time system
|
|
|
|
.BR ocamlrun (1)
|
|
|
|
at program start-up time.
|
|
|
|
.TP
|
|
|
|
.BI \-dllpath \ dir
|
|
|
|
Adds the directory
|
|
|
|
.I dir
|
|
|
|
to the run-time search path for shared
|
|
|
|
C libraries. At link-time, shared libraries are searched in the
|
|
|
|
standard search path (the one corresponding to the
|
|
|
|
.B \-I
|
|
|
|
option).
|
|
|
|
The
|
|
|
|
.B \-dllpath
|
|
|
|
option simply stores
|
|
|
|
.I dir
|
|
|
|
in the produced
|
|
|
|
executable file, where
|
|
|
|
.BR ocamlrun (1)
|
|
|
|
can find it and use it.
|
|
|
|
.TP
|
2015-12-11 03:58:07 -08:00
|
|
|
.BI \-for\-pack \ module\-path
|
2015-12-28 05:04:21 -08:00
|
|
|
Generate an object file (.cmo file) that can later be included
|
2015-12-11 03:58:07 -08:00
|
|
|
as a sub-module (with the given access path) of a compilation unit
|
|
|
|
constructed with
|
|
|
|
.BR \-pack .
|
|
|
|
For instance,
|
|
|
|
.B ocamlc\ \-for\-pack\ P\ \-c\ A.ml
|
|
|
|
will generate a.cmo that can later be used with
|
|
|
|
.BR "ocamlc -pack -o P.cmo a.cmo" .
|
2015-12-28 05:04:21 -08:00
|
|
|
Note: you can still pack a module that was compiled without
|
|
|
|
.B \-for\-pack
|
|
|
|
but in this case exceptions will be printed with the wrong names.
|
2013-09-04 08:12:37 -07:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-g
|
|
|
|
Add debugging information while compiling and linking. This option is
|
|
|
|
required in order to be able to debug the program with
|
|
|
|
.BR ocamldebug (1)
|
|
|
|
and to produce stack backtraces when
|
|
|
|
the program terminates on an uncaught exception.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
|
|
|
.B \-i
|
|
|
|
Cause the compiler to print all defined names (with their inferred
|
|
|
|
types or their definitions) when compiling an implementation (.ml
|
2008-09-11 09:16:27 -07:00
|
|
|
file). No compiled files (.cmo and .cmi files) are produced.
|
|
|
|
This can be useful to check the types inferred by the
|
1995-11-02 08:54:37 -08:00
|
|
|
compiler. Also, since the output follows the syntax of interfaces, it
|
|
|
|
can help in writing an explicit interface (.mli file) for a file: just
|
|
|
|
redirect the standard output of the compiler to a .mli file, and edit
|
|
|
|
that file to remove all declarations of unexported names.
|
|
|
|
.TP
|
2007-02-09 05:31:15 -08:00
|
|
|
.BI \-I \ directory
|
1995-11-02 08:54:37 -08:00
|
|
|
Add the given directory to the list of directories searched for
|
2008-09-11 09:16:27 -07:00
|
|
|
compiled interface files (.cmi), compiled object code files
|
|
|
|
(.cmo), libraries (.cma), and C libraries specified with
|
2014-01-22 06:01:10 -08:00
|
|
|
.BI \-cclib\ \-l xxx
|
|
|
|
.RB .
|
2008-09-11 09:16:27 -07:00
|
|
|
By default, the current directory is searched first, then the
|
1995-11-02 08:54:37 -08:00
|
|
|
standard library directory. Directories added with
|
2014-01-22 06:01:10 -08:00
|
|
|
.B \-I
|
1995-11-02 08:54:37 -08:00
|
|
|
are searched
|
|
|
|
after the current directory, in the order in which they were given on
|
2014-01-22 06:01:10 -08:00
|
|
|
the command line, but before the standard library directory. See also
|
|
|
|
option
|
|
|
|
.BR \-nostdlib .
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
If the given directory starts with
|
|
|
|
.BR + ,
|
|
|
|
it is taken relative to the
|
|
|
|
standard library directory. For instance,
|
2014-12-13 14:36:00 -08:00
|
|
|
.B \-I\ +compiler-libs
|
2008-09-11 09:16:27 -07:00
|
|
|
adds the subdirectory
|
2014-12-13 14:36:00 -08:00
|
|
|
.B compiler-libs
|
2008-09-11 09:16:27 -07:00
|
|
|
of the standard library to the search path.
|
|
|
|
.TP
|
|
|
|
.BI \-impl \ filename
|
|
|
|
Compile the file
|
|
|
|
.I filename
|
|
|
|
as an implementation file, even if its extension is not .ml.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-intf \ filename
|
|
|
|
Compile the file
|
|
|
|
.I filename
|
|
|
|
as an interface file, even if its extension is not .mli.
|
|
|
|
.TP
|
|
|
|
.BI \-intf\-suffix \ string
|
|
|
|
Recognize file names ending with
|
|
|
|
.I string
|
|
|
|
as interface files (instead of the default .mli).
|
|
|
|
.TP
|
2015-06-28 06:11:50 -07:00
|
|
|
.B \-keep-docs
|
|
|
|
Keep documentation strings in generated .cmi files.
|
|
|
|
.TP
|
2013-09-17 05:45:05 -07:00
|
|
|
.B \-keep-locs
|
|
|
|
Keep locations in generated .cmi files.
|
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-labels
|
|
|
|
Labels are not ignored in types, labels may be used in applications,
|
|
|
|
and labelled parameters can be given in any order. This is the default.
|
|
|
|
.TP
|
|
|
|
.B \-linkall
|
|
|
|
Force all modules contained in libraries to be linked in. If this
|
|
|
|
flag is not given, unreferenced modules are not linked in. When
|
|
|
|
building a library (option
|
|
|
|
.BR \-a ),
|
|
|
|
setting the
|
2008-09-15 07:05:30 -07:00
|
|
|
.B \-linkall
|
2008-09-11 09:16:27 -07:00
|
|
|
option forces all subsequent links of programs involving that library
|
|
|
|
to link all the modules contained in the library.
|
2017-01-15 10:18:58 -08:00
|
|
|
When compiling a module (option
|
|
|
|
.BR \-c ),
|
|
|
|
setting the
|
|
|
|
.B \-linkall
|
|
|
|
option ensures that this module will
|
|
|
|
always be linked if it is put in a library and this library is linked.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
|
|
|
.B \-make\-runtime
|
|
|
|
Build a custom runtime system (in the file specified by option
|
|
|
|
.BR \-o )
|
|
|
|
incorporating the C object files and libraries given on the command
|
|
|
|
line. This custom runtime system can be used later to execute
|
|
|
|
bytecode executables produced with the option
|
|
|
|
.B ocamlc\ \-use\-runtime
|
|
|
|
.IR runtime-name .
|
|
|
|
.TP
|
2018-05-18 14:21:01 -07:00
|
|
|
.B \-match\-context\-rows
|
|
|
|
Set number of rows of context used during pattern matching
|
|
|
|
compilation. Lower values cause faster compilation, but
|
|
|
|
less optimized code. The default value is 32.
|
|
|
|
.TP
|
2014-05-06 17:34:20 -07:00
|
|
|
.B \-no-alias-deps
|
|
|
|
Do not record dependencies for module aliases.
|
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.B \-no\-app\-funct
|
|
|
|
Deactivates the applicative behaviour of functors. With this option,
|
|
|
|
each functor application generates new types in its result and
|
|
|
|
applying the same functor twice to the same argument yields two
|
|
|
|
incompatible structures.
|
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-noassert
|
|
|
|
Do not compile assertion checks. Note that the special form
|
2008-09-15 07:05:30 -07:00
|
|
|
.B assert\ false
|
2008-09-11 09:16:27 -07:00
|
|
|
is always compiled because it is typed specially.
|
|
|
|
This flag has no effect when linking already-compiled files.
|
|
|
|
.TP
|
|
|
|
.B \-noautolink
|
|
|
|
When linking .cma libraries, ignore
|
|
|
|
.BR \-custom , \ \-cclib \ and \ \-ccopt
|
|
|
|
options potentially contained in the libraries (if these options were
|
|
|
|
given when building the libraries). This can be useful if a library
|
|
|
|
contains incorrect specifications of C libraries or C options; in this
|
|
|
|
case, during linking, set
|
|
|
|
.B \-noautolink
|
|
|
|
and pass the correct C libraries and options on the command line.
|
|
|
|
.TP
|
|
|
|
.B \-nolabels
|
|
|
|
Ignore non-optional labels in types. Labels cannot be used in
|
|
|
|
applications, and parameter order becomes strict.
|
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.B \-nostdlib
|
2014-01-22 06:01:10 -08:00
|
|
|
Do not automatically add the standard library directory to the list of
|
|
|
|
directories searched for compiled interface files (.cmi), compiled
|
|
|
|
object code files (.cmo), libraries (.cma), and C libraries specified
|
|
|
|
with
|
|
|
|
.BI \-cclib\ \-l xxx
|
|
|
|
.RB .
|
|
|
|
See also option
|
|
|
|
.BR \-I .
|
2013-09-04 08:12:37 -07:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-o \ exec\-file
|
1995-11-02 08:54:37 -08:00
|
|
|
Specify the name of the output file produced by the linker. The
|
2008-09-11 09:16:27 -07:00
|
|
|
default output name is
|
1995-11-02 08:54:37 -08:00
|
|
|
.BR a.out ,
|
2008-09-11 09:16:27 -07:00
|
|
|
in keeping with the Unix tradition. If the
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-a
|
2008-09-11 09:16:27 -07:00
|
|
|
option is given, specify the name of the library
|
|
|
|
produced. If the
|
|
|
|
.B \-pack
|
|
|
|
option is given, specify the name of the
|
|
|
|
packed object file produced. If the
|
|
|
|
.B \-output\-obj
|
|
|
|
option is given,
|
|
|
|
specify the name of the output file produced.
|
2014-05-10 17:17:05 -07:00
|
|
|
This can also be used when compiling an interface or implementation
|
|
|
|
file, without linking, in which case it sets the name of the cmi or
|
|
|
|
cmo file, and also sets the module name to the file name up to the
|
|
|
|
first dot.
|
|
|
|
.TP
|
2016-06-22 13:25:10 -07:00
|
|
|
.B \-opaque
|
2017-02-24 18:51:32 -08:00
|
|
|
Interface file compiled with this option are marked so that other
|
|
|
|
compilation units depending on it will not rely on any implementation
|
|
|
|
details of the compiled implementation. The native compiler will not
|
|
|
|
access the .cmx file of this unit -- nor warn if it is absent. This can
|
|
|
|
improve speed of compilation, for both initial and incremental builds,
|
|
|
|
at the expense of performance of the generated code.
|
2016-06-22 13:25:10 -07:00
|
|
|
.TP
|
2014-05-10 17:17:05 -07:00
|
|
|
.BI \-open \ module
|
|
|
|
Opens the given module before processing the interface or
|
|
|
|
implementation files. If several
|
|
|
|
.B \-open
|
|
|
|
options are given, they are processed in order, just as if
|
2014-05-10 17:25:57 -07:00
|
|
|
the statements open! module1;; ... open! moduleN;; were added
|
2014-05-10 17:17:05 -07:00
|
|
|
at the top of each file.
|
1995-11-02 08:54:37 -08:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-output\-obj
|
|
|
|
Cause the linker to produce a C object file instead of a bytecode
|
2011-06-15 05:24:26 -07:00
|
|
|
executable file. This is useful to wrap OCaml code as a C library,
|
2012-07-30 11:04:46 -07:00
|
|
|
callable from any C program. The name of the output object file
|
2012-03-08 11:52:03 -08:00
|
|
|
must be set with the
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-o
|
|
|
|
option. This
|
|
|
|
option can also be used to produce a C source file (.c extension) or
|
|
|
|
a compiled shared/dynamic library (.so extension).
|
|
|
|
.TP
|
|
|
|
.B \-pack
|
|
|
|
Build a bytecode object file (.cmo file) and its associated compiled
|
|
|
|
interface (.cmi) that combines the object
|
|
|
|
files given on the command line, making them appear as sub-modules of
|
|
|
|
the output .cmo file. The name of the output .cmo file must be
|
|
|
|
given with the
|
|
|
|
.B \-o
|
|
|
|
option. For instance,
|
2008-09-15 07:05:30 -07:00
|
|
|
.B ocamlc\ \-pack\ \-o\ p.cmo\ a.cmo\ b.cmo\ c.cmo
|
2008-09-11 09:16:27 -07:00
|
|
|
generates compiled files p.cmo and p.cmi describing a compilation
|
|
|
|
unit having three sub-modules A, B and C, corresponding to the
|
|
|
|
contents of the object files a.cmo, b.cmo and c.cmo. These
|
|
|
|
contents can be referenced as P.A, P.B and P.C in the remainder
|
|
|
|
of the program.
|
|
|
|
.TP
|
|
|
|
.BI \-pp \ command
|
|
|
|
Cause the compiler to call the given
|
|
|
|
.I command
|
|
|
|
as a preprocessor for each source file. The output of
|
|
|
|
.I command
|
|
|
|
is redirected to
|
|
|
|
an intermediate file, which is compiled. If there are no compilation
|
|
|
|
errors, the intermediate file is deleted afterwards. The name of this
|
2008-12-03 10:09:09 -08:00
|
|
|
file is built from the basename of the source file with the
|
|
|
|
extension .ppi for an interface (.mli) file and .ppo for an
|
|
|
|
implementation (.ml) file.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
2012-06-13 03:02:28 -07:00
|
|
|
.BI \-ppx \ command
|
2013-09-04 08:12:37 -07:00
|
|
|
After parsing, pipe the abstract syntax tree through the preprocessor
|
2012-06-13 03:02:28 -07:00
|
|
|
.IR command .
|
2014-10-04 03:39:29 -07:00
|
|
|
The module
|
|
|
|
.BR Ast_mapper (3)
|
|
|
|
implements the external interface of a preprocessor.
|
2012-06-13 03:02:28 -07:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.B \-principal
|
|
|
|
Check information path during type-checking, to make sure that all
|
|
|
|
types are derived in a principal way. When using labelled arguments
|
|
|
|
and/or polymorphic methods, this flag is required to ensure future
|
|
|
|
versions of the compiler will be able to infer types correctly, even
|
|
|
|
if internal algorithms change.
|
|
|
|
All programs accepted in
|
|
|
|
.B \-principal
|
|
|
|
mode are also accepted in the
|
|
|
|
default mode with equivalent types, but different binary signatures,
|
|
|
|
and this may slow down type checking; yet it is a good idea to
|
|
|
|
use it once before publishing source code.
|
|
|
|
.TP
|
|
|
|
.B \-rectypes
|
|
|
|
Allow arbitrary recursive types during type-checking. By default,
|
|
|
|
only recursive types where the recursion goes through an object type
|
|
|
|
are supported. Note that once you have created an interface using this
|
|
|
|
flag, you must use it again for all dependencies.
|
|
|
|
.TP
|
2011-03-17 09:18:05 -07:00
|
|
|
.BI \-runtime\-variant \ suffix
|
|
|
|
Add
|
|
|
|
.I suffix
|
|
|
|
to the name of the runtime library that will be used by the program.
|
|
|
|
If OCaml was configured with option
|
|
|
|
.BR \-with\-debug\-runtime ,
|
|
|
|
then the
|
|
|
|
.B d
|
|
|
|
suffix is supported and gives a debug version of the runtime.
|
|
|
|
.TP
|
2015-11-10 03:18:48 -08:00
|
|
|
.BI \-stop\-after \ pass
|
|
|
|
Stop compilation after the given compilation pass. The currently
|
|
|
|
supported passes are:
|
|
|
|
.BR parsing ,
|
|
|
|
.BR typing .
|
|
|
|
.TP
|
2014-04-29 04:56:17 -07:00
|
|
|
.B \-safe\-string
|
|
|
|
Enforce the separation between types
|
|
|
|
.BR string \ and\ bytes ,
|
2018-05-31 09:11:14 -07:00
|
|
|
thereby making strings read-only. This is the default.
|
2014-04-29 04:56:17 -07:00
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.B \-short\-paths
|
|
|
|
When a type is visible under several module-paths, use the shortest
|
|
|
|
one when printing the type's name in inferred interfaces and error and
|
|
|
|
warning messages.
|
|
|
|
.TP
|
2011-06-20 14:42:19 -07:00
|
|
|
.B \-strict\-sequence
|
2013-09-04 08:12:37 -07:00
|
|
|
Force the left-hand part of each sequence to have type unit.
|
2011-06-20 14:42:19 -07:00
|
|
|
.TP
|
2016-05-25 07:29:05 -07:00
|
|
|
.B \-unboxed\-types
|
|
|
|
When a type is unboxable (i.e. a record with a single argument or a
|
|
|
|
concrete datatype with a single constructor of one argument) it will
|
|
|
|
be unboxed unless annotated with
|
|
|
|
.BR [@@ocaml.boxed] .
|
|
|
|
.TP
|
|
|
|
.B \-no-unboxed\-types
|
|
|
|
When a type is unboxable it will be boxed unless annotated with
|
|
|
|
.BR [@@ocaml.unboxed] .
|
|
|
|
This is the default.
|
|
|
|
.TP
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-unsafe
|
2008-09-15 07:05:30 -07:00
|
|
|
Turn bound checking off for array and string accesses (the
|
2008-09-11 09:16:27 -07:00
|
|
|
.BR v.(i) and s.[i]
|
|
|
|
constructs). Programs compiled with
|
1995-11-02 08:54:37 -08:00
|
|
|
.B \-unsafe
|
|
|
|
are therefore
|
|
|
|
slightly faster, but unsafe: anything can happen if the program
|
|
|
|
accesses an array or string outside of its bounds.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
2014-04-29 04:56:17 -07:00
|
|
|
.B \-unsafe\-string
|
|
|
|
Identify the types
|
|
|
|
.BR string \ and\ bytes ,
|
2018-05-31 09:11:14 -07:00
|
|
|
thereby making strings writable.
|
|
|
|
This is intended for compatibility with old source code and should not
|
|
|
|
be used with new software.
|
2014-04-29 04:56:17 -07:00
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-use\-runtime \ runtime\-name
|
|
|
|
Generate a bytecode executable file that can be executed on the custom
|
|
|
|
runtime system
|
|
|
|
.IR runtime\-name ,
|
|
|
|
built earlier with
|
2008-09-15 07:05:30 -07:00
|
|
|
.B ocamlc\ \-make\-runtime
|
2008-09-11 09:16:27 -07:00
|
|
|
.IR runtime\-name .
|
|
|
|
.TP
|
|
|
|
.B \-v
|
|
|
|
Print the version number of the compiler and the location of the
|
|
|
|
standard library directory, then exit.
|
|
|
|
.TP
|
|
|
|
.B \-verbose
|
|
|
|
Print all external commands before they are executed, in particular
|
|
|
|
invocations of the C compiler and linker in
|
|
|
|
.B \-custom
|
|
|
|
mode. Useful to debug C library problems.
|
|
|
|
.TP
|
2013-09-04 08:12:37 -07:00
|
|
|
.BR \-vnum \ or\ \-version
|
|
|
|
Print the version number of the compiler in short form (e.g. "3.11.0"),
|
|
|
|
then exit.
|
|
|
|
.TP
|
2008-09-11 09:16:27 -07:00
|
|
|
.BI \-w \ warning\-list
|
2013-09-04 08:12:37 -07:00
|
|
|
Enable, disable, or mark as fatal the warnings specified by the argument
|
2008-09-11 09:16:27 -07:00
|
|
|
.IR warning\-list .
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
Each warning can be
|
|
|
|
.IR enabled \ or\ disabled ,
|
|
|
|
and each warning can be
|
2020-07-07 12:45:39 -07:00
|
|
|
.IR fatal \ or
|
2013-09-04 08:12:37 -07:00
|
|
|
.IR non-fatal .
|
2009-11-02 04:17:49 -08:00
|
|
|
If a warning is disabled, it isn't displayed and doesn't affect
|
2013-09-04 08:12:37 -07:00
|
|
|
compilation in any way (even if it is fatal). If a warning is enabled,
|
2009-11-02 04:17:49 -08:00
|
|
|
it is displayed normally by the compiler whenever the source code
|
2013-09-04 08:12:37 -07:00
|
|
|
triggers it. If it is enabled and fatal, the compiler will also stop
|
|
|
|
with an error after displaying it.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
The
|
|
|
|
.I warning\-list
|
|
|
|
argument is a sequence of warning specifiers, with no separators
|
|
|
|
between them. A warning specifier is one of the following:
|
|
|
|
|
|
|
|
.BI + num
|
|
|
|
\ \ Enable warning number
|
|
|
|
.IR num .
|
|
|
|
|
|
|
|
.BI \- num
|
|
|
|
\ \ Disable warning number
|
|
|
|
.IR num .
|
|
|
|
|
|
|
|
.BI @ num
|
2013-09-04 08:12:37 -07:00
|
|
|
\ \ Enable and mark as fatal warning number
|
2009-11-02 04:17:49 -08:00
|
|
|
.IR num .
|
|
|
|
|
2012-01-27 05:28:56 -08:00
|
|
|
.BI + num1 .. num2
|
|
|
|
\ \ Enable all warnings between
|
|
|
|
.I num1
|
|
|
|
and
|
|
|
|
.I num2
|
|
|
|
(inclusive).
|
|
|
|
|
|
|
|
.BI \- num1 .. num2
|
|
|
|
\ \ Disable all warnings between
|
|
|
|
.I num1
|
|
|
|
and
|
|
|
|
.I num2
|
|
|
|
(inclusive).
|
|
|
|
|
|
|
|
.BI @ num1 .. num2
|
2013-09-04 08:12:37 -07:00
|
|
|
\ \ Enable and mark as fatal all warnings between
|
2012-01-27 05:28:56 -08:00
|
|
|
.I num1
|
|
|
|
and
|
|
|
|
.I num2
|
|
|
|
(inclusive).
|
|
|
|
|
2009-11-02 04:17:49 -08:00
|
|
|
.BI + letter
|
|
|
|
\ \ Enable the set of warnings corresponding to
|
|
|
|
.IR letter .
|
|
|
|
The letter may be uppercase or lowercase.
|
|
|
|
|
|
|
|
.BI \- letter
|
|
|
|
\ \ Disable the set of warnings corresponding to
|
|
|
|
.IR letter .
|
|
|
|
The letter may be uppercase or lowercase.
|
|
|
|
|
|
|
|
.BI @ letter
|
2013-09-04 08:12:37 -07:00
|
|
|
\ \ Enable and mark as fatal the set of warnings corresponding to
|
2009-11-02 04:17:49 -08:00
|
|
|
.IR letter .
|
|
|
|
The letter may be uppercase or lowercase.
|
|
|
|
|
|
|
|
.I uppercase\-letter
|
|
|
|
\ \ Enable the set of warnings corresponding to
|
|
|
|
.IR uppercase\-letter .
|
|
|
|
|
|
|
|
.I lowercase\-letter
|
|
|
|
\ \ Disable the set of warnings corresponding to
|
|
|
|
.IR lowercase\-letter .
|
|
|
|
|
|
|
|
The warning numbers are as follows.
|
|
|
|
|
|
|
|
1
|
|
|
|
\ \ \ Suspicious-looking start-of-comment mark.
|
|
|
|
|
|
|
|
2
|
|
|
|
\ \ \ Suspicious-looking end-of-comment mark.
|
|
|
|
|
|
|
|
3
|
2013-09-04 08:12:37 -07:00
|
|
|
\ \ \ Deprecated feature.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
4
|
|
|
|
\ \ \ Fragile pattern matching: matching that will remain
|
|
|
|
complete even if additional constructors are added to one of the
|
|
|
|
variant types matched.
|
|
|
|
|
|
|
|
5
|
|
|
|
\ \ \ Partially applied function: expression whose result has
|
|
|
|
function type and is ignored.
|
|
|
|
|
|
|
|
6
|
|
|
|
\ \ \ Label omitted in function application.
|
|
|
|
|
|
|
|
7
|
2020-03-28 12:41:02 -07:00
|
|
|
\ \ \ Method overridden without using the "method!" keyword.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
8
|
|
|
|
\ \ \ Partial match: missing cases in pattern-matching.
|
|
|
|
|
|
|
|
9
|
|
|
|
\ \ \ Missing fields in a record pattern.
|
|
|
|
|
|
|
|
10
|
|
|
|
\ \ Expression on the left-hand side of a sequence that doesn't
|
|
|
|
have type
|
|
|
|
.B unit
|
|
|
|
(and that is not a function, see warning number 5).
|
|
|
|
|
|
|
|
11
|
|
|
|
\ \ Redundant case in a pattern matching (unused match case).
|
|
|
|
|
|
|
|
12
|
|
|
|
\ \ Redundant sub-pattern in a pattern-matching.
|
|
|
|
|
|
|
|
13
|
|
|
|
\ \ Override of an instance variable.
|
|
|
|
|
|
|
|
14
|
|
|
|
\ \ Illegal backslash escape in a string constant.
|
|
|
|
|
|
|
|
15
|
|
|
|
\ \ Private method made public implicitly.
|
|
|
|
|
|
|
|
16
|
|
|
|
\ \ Unerasable optional argument.
|
|
|
|
|
|
|
|
17
|
|
|
|
\ \ Undeclared virtual method.
|
|
|
|
|
|
|
|
18
|
|
|
|
\ \ Non-principal type.
|
|
|
|
|
|
|
|
19
|
|
|
|
\ \ Type without principality.
|
|
|
|
|
|
|
|
20
|
|
|
|
\ \ Unused function argument.
|
|
|
|
|
|
|
|
21
|
|
|
|
\ \ Non-returning statement.
|
|
|
|
|
|
|
|
22
|
2014-12-13 14:36:00 -08:00
|
|
|
\ \ Preprocessor warning.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
23
|
|
|
|
\ \ Useless record
|
|
|
|
.B with
|
|
|
|
clause.
|
|
|
|
|
|
|
|
24
|
|
|
|
\ \ Bad module name: the source file name is not a valid OCaml module name.
|
|
|
|
|
|
|
|
25
|
2017-07-10 09:18:37 -07:00
|
|
|
\ \ Deprecated: now part of warning 8.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
|
|
|
26
|
|
|
|
\ \ Suspicious unused variable: unused variable that is bound with
|
|
|
|
.BR let \ or \ as ,
|
|
|
|
and doesn't start with an underscore (_) character.
|
|
|
|
|
|
|
|
27
|
|
|
|
\ \ Innocuous unused variable: unused variable that is not bound with
|
|
|
|
.BR let \ nor \ as ,
|
|
|
|
and doesn't start with an underscore (_) character.
|
|
|
|
|
2010-01-29 07:02:52 -08:00
|
|
|
28
|
|
|
|
\ \ A pattern contains a constant constructor applied to the underscore (_)
|
|
|
|
pattern.
|
|
|
|
|
|
|
|
29
|
|
|
|
\ \ A non-escaped end-of-line was found in a string constant. This may
|
|
|
|
cause portability problems between Unix and Windows.
|
|
|
|
|
2013-09-04 08:12:37 -07:00
|
|
|
30
|
|
|
|
\ \ Two labels or constructors of the same name are defined in two
|
|
|
|
mutually recursive types.
|
|
|
|
|
|
|
|
31
|
|
|
|
\ \ A module is linked twice in the same executable.
|
|
|
|
|
|
|
|
32
|
|
|
|
\ \ Unused value declaration.
|
|
|
|
|
|
|
|
33
|
|
|
|
\ \ Unused open statement.
|
|
|
|
|
|
|
|
34
|
|
|
|
\ \ Unused type declaration.
|
|
|
|
|
|
|
|
35
|
|
|
|
\ \ Unused for-loop index.
|
|
|
|
|
|
|
|
36
|
|
|
|
\ \ Unused ancestor variable.
|
|
|
|
|
|
|
|
37
|
|
|
|
\ \ Unused constructor.
|
|
|
|
|
|
|
|
38
|
2014-05-04 16:08:45 -07:00
|
|
|
\ \ Unused extension constructor.
|
2013-09-04 08:12:37 -07:00
|
|
|
|
|
|
|
39
|
|
|
|
\ \ Unused rec flag.
|
|
|
|
|
|
|
|
40
|
|
|
|
\ \ Constructor or label name used out of scope.
|
|
|
|
|
|
|
|
41
|
|
|
|
\ \ Ambiguous constructor or label name.
|
|
|
|
|
|
|
|
42
|
|
|
|
\ \ Disambiguated constructor or label name.
|
|
|
|
|
|
|
|
43
|
|
|
|
\ \ Nonoptional label applied as optional.
|
|
|
|
|
|
|
|
44
|
|
|
|
\ \ Open statement shadows an already defined identifier.
|
|
|
|
|
|
|
|
45
|
|
|
|
\ \ Open statement shadows an already defined label or constructor.
|
|
|
|
|
2015-06-28 06:11:50 -07:00
|
|
|
46
|
|
|
|
\ \ Error in environment variable.
|
|
|
|
|
|
|
|
47
|
|
|
|
\ \ Illegal attribute payload.
|
|
|
|
|
|
|
|
48
|
|
|
|
\ \ Implicit elimination of optional arguments.
|
|
|
|
|
|
|
|
49
|
|
|
|
\ \ Missing cmi file when looking up module alias.
|
|
|
|
|
|
|
|
50
|
|
|
|
\ \ Unexpected documentation comment.
|
|
|
|
|
2016-01-14 04:06:12 -08:00
|
|
|
59
|
|
|
|
\ \ Assignment on non-mutable value.
|
|
|
|
|
2016-01-12 14:53:59 -08:00
|
|
|
60
|
|
|
|
\ \ Unused module declaration.
|
|
|
|
|
2016-05-25 07:29:05 -07:00
|
|
|
61
|
|
|
|
\ \ Unannotated unboxable type in primitive declaration.
|
|
|
|
|
2018-07-15 12:01:14 -07:00
|
|
|
62
|
2020-03-28 12:41:02 -07:00
|
|
|
\ \ Type constraint on GADT type declaration.
|
2018-07-15 12:01:14 -07:00
|
|
|
|
|
|
|
63
|
2020-03-28 12:41:02 -07:00
|
|
|
\ \ Erroneous printed signature.
|
2018-07-15 12:01:14 -07:00
|
|
|
|
2018-07-15 12:01:22 -07:00
|
|
|
64
|
2020-03-28 12:41:02 -07:00
|
|
|
\ \ -unsafe used with a preprocessor returning a syntax tree.
|
2018-07-15 12:01:22 -07:00
|
|
|
|
2018-10-04 10:08:39 -07:00
|
|
|
65
|
2020-03-28 12:41:02 -07:00
|
|
|
\ \ Type declaration defining a new '()' constructor.
|
2018-10-04 10:08:39 -07:00
|
|
|
|
2018-11-09 04:41:34 -08:00
|
|
|
66
|
|
|
|
\ \ Unused open! statement.
|
|
|
|
|
2020-03-09 11:38:48 -07:00
|
|
|
67
|
|
|
|
\ \ Unused functor parameter.
|
|
|
|
|
2020-08-17 01:47:36 -07:00
|
|
|
68
|
|
|
|
\ \ Pattern-matching depending on mutable state prevents the remaining
|
|
|
|
arguments from being uncurried.
|
|
|
|
|
2009-11-02 04:17:49 -08:00
|
|
|
The letters stand for the following sets of warnings. Any letter not
|
|
|
|
mentioned here corresponds to the empty set.
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B A
|
2009-11-02 04:17:49 -08:00
|
|
|
\ all warnings
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B C
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 1, 2
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B D
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 3
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B E
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 4
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B F
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 5
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2012-01-18 01:22:42 -08:00
|
|
|
.B K
|
2013-09-04 08:12:37 -07:00
|
|
|
\ 32, 33, 34, 35, 36, 37, 38, 39
|
2012-01-18 01:22:42 -08:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B L
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 6
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B M
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 7
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B P
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 8
|
|
|
|
|
|
|
|
.B R
|
|
|
|
\ 9
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B S
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 10
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B U
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 11, 12
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B V
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 13
|
|
|
|
|
|
|
|
.B X
|
2012-01-18 01:22:42 -08:00
|
|
|
\ 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 30
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B Y
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 26
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.B Z
|
2009-11-02 04:17:49 -08:00
|
|
|
\ 27
|
2008-09-15 07:05:30 -07:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
.IP
|
|
|
|
The default setting is
|
2020-08-17 01:47:36 -07:00
|
|
|
.BR \-w\ +a\-4\-6\-7\-9\-27\-29\-30\-32..42\-44\-45\-48\-50\-60\-66\-67\-68 .
|
2008-09-11 09:16:27 -07:00
|
|
|
Note that warnings
|
2009-11-02 04:17:49 -08:00
|
|
|
.BR 5 \ and \ 10
|
2008-09-11 09:16:27 -07:00
|
|
|
are not always triggered, depending on the internals of the type checker.
|
|
|
|
.TP
|
|
|
|
.BI \-warn\-error \ warning\-list
|
2009-11-02 04:17:49 -08:00
|
|
|
Mark as errors the warnings specified in the argument
|
|
|
|
.IR warning\-list .
|
|
|
|
The compiler will stop with an error when one of these
|
2008-09-11 09:16:27 -07:00
|
|
|
warnings is emitted. The
|
|
|
|
.I warning\-list
|
|
|
|
has the same meaning as for
|
2009-11-02 04:17:49 -08:00
|
|
|
the
|
|
|
|
.B \-w
|
|
|
|
option: a
|
|
|
|
.B +
|
2013-09-04 08:12:37 -07:00
|
|
|
sign (or an uppercase letter) marks the corresponding warnings as fatal, a
|
2009-11-02 04:17:49 -08:00
|
|
|
.B \-
|
2013-09-04 08:12:37 -07:00
|
|
|
sign (or a lowercase letter) turns them back into non-fatal warnings, and a
|
2009-11-02 04:17:49 -08:00
|
|
|
.B @
|
2013-09-04 08:12:37 -07:00
|
|
|
sign both enables and marks as fatal the corresponding warnings.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
2012-01-27 03:25:02 -08:00
|
|
|
Note: it is not recommended to use the
|
2009-11-02 04:17:49 -08:00
|
|
|
.B \-warn\-error
|
2012-01-27 03:25:02 -08:00
|
|
|
option in production code, because it will almost certainly prevent
|
|
|
|
compiling your program with later versions of OCaml when they add new
|
2014-05-07 07:04:47 -07:00
|
|
|
warnings or modify existing warnings.
|
2009-11-02 04:17:49 -08:00
|
|
|
|
2008-09-11 09:16:27 -07:00
|
|
|
The default setting is
|
2015-12-09 09:47:47 -08:00
|
|
|
.B \-warn\-error \-a+31
|
2016-05-25 07:29:05 -07:00
|
|
|
(only warning 31 is fatal).
|
2013-09-04 08:12:37 -07:00
|
|
|
.TP
|
|
|
|
.B \-warn\-help
|
|
|
|
Show the description of all available warning numbers.
|
2008-09-11 09:16:27 -07:00
|
|
|
.TP
|
|
|
|
.B \-where
|
|
|
|
Print the location of the standard library, then exit.
|
2008-09-11 09:34:57 -07:00
|
|
|
.TP
|
2019-06-11 01:06:56 -07:00
|
|
|
.B \-with-runtime
|
|
|
|
Include the runtime system in the generated program. This is the default.
|
|
|
|
.TP
|
2019-03-11 04:45:55 -07:00
|
|
|
.B \-without-runtime
|
|
|
|
The compiler does not include the runtime system (nor a reference to it) in the
|
|
|
|
generated program; it must be supplied separately.
|
|
|
|
.TP
|
2008-09-11 09:34:57 -07:00
|
|
|
.BI \- \ file
|
|
|
|
Process
|
|
|
|
.I file
|
|
|
|
as a file name, even if it starts with a dash (-) character.
|
|
|
|
.TP
|
|
|
|
.BR \-help \ or \ \-\-help
|
2008-09-15 07:05:30 -07:00
|
|
|
Display a short usage summary and exit.
|
1995-11-02 08:54:37 -08:00
|
|
|
|
|
|
|
.SH SEE ALSO
|
2008-09-11 09:16:27 -07:00
|
|
|
.BR ocamlopt (1), \ ocamlrun (1), \ ocaml (1).
|
1995-11-02 08:54:37 -08:00
|
|
|
.br
|
2011-04-26 05:16:50 -07:00
|
|
|
.IR "The OCaml user's manual" ,
|
1995-11-02 08:54:37 -08:00
|
|
|
chapter "Batch compilation".
|