Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Added options and negative options to manpages #11647

Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions man/ocaml.1
Expand Up @@ -167,6 +167,10 @@ Allow arbitrary recursive types during type-checking. By default,
only recursive types where the recursion goes through an object type
are supported.
.TP
.B \-no-rectypes
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Do no allow arbitrary recursive types during type-checking.
This is the default.
.TP
.B \-safe\-string
Enforce the separation between types
.BR string \ and\ bytes ,
Expand All @@ -190,6 +194,10 @@ interactive session.
.B \-strict\-sequence
Force the left-hand part of each sequence to have type unit.
.TP
.B \-no-strict\-sequence
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.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
Expand Down
12 changes: 12 additions & 0 deletions man/ocamlc.1
Expand Up @@ -620,12 +620,20 @@ 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 \-no-principal
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Do not check principality of type inference.
This is the default.
.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
.B \-no-rectypes
Do no allow arbitrary recursive types during type-checking.
This is the default.
.TP
.BI \-runtime\-variant \ suffix
Add
.I suffix
Expand Down Expand Up @@ -661,6 +669,10 @@ supported passes are:
.B \-strict\-sequence
Force the left-hand part of each sequence to have type unit.
.TP
.B \-no-strict\-sequence
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.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
Expand Down
11 changes: 11 additions & 0 deletions man/ocamlopt.1
Expand Up @@ -540,13 +540,20 @@ types are derived in a principal way. All programs accepted in
.B \-principal
mode are also accepted in default mode with equivalent
types, but different binary signatures.
.B \-no-principal
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Do not check principality of type inference.
This is the default.
.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
.B \-no-rectypes
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Do no allow arbitrary recursive types during type-checking.
This is the default.
.TP
.BI \-runtime\-variant \ suffix
Add
.I suffix
Expand Down Expand Up @@ -614,6 +621,10 @@ supported passes are:
.B \-strict\-sequence
The left-hand part of a sequence must have type unit.
.TP
.B \-no-strict\-sequence
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.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
Expand Down