Skip to content

Commit

Permalink
Documentation: Added negative options to manpages (#11647)
Browse files Browse the repository at this point in the history
  • Loading branch information
nangahamandine committed Oct 21, 2022
1 parent be1e1d6 commit 9f1f71d
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Changes
Expand Up @@ -472,9 +472,10 @@ OCaml 5.0
Scherer, Thomas Leonard, Tom Ridge, Xavier Leroy, Luc Maranget, Fabrice
Buoro, Olivier Nicole, Guillaume Munch-Maccagnoni, Jacques-Henri Jourdan)

- #11640: Add Flambda commonly-used options to the ocamlopt manpage
(Amandine Nangah, review by David Allsopp, Florian Angeletti,
Sébastien Hinderer, and Vincent Laviron)
- #11640, #11647: Add missing options to the man pages:
flambda commonly-used options, and negative options (`-no-rectypes`, ... ).
(Amandine Nangah, review by David Allsopp, Florian Angeletti,
Sébastien Hinderer, and Vincent Laviron)

### Compiler user-interface and warnings:

Expand Down
12 changes: 12 additions & 0 deletions man/ocaml.1
Expand Up @@ -162,11 +162,19 @@ 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
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.
.TP
.B \-no\-rectypes
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 +198,10 @@ interactive session.
.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
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
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
12 changes: 12 additions & 0 deletions man/ocamlopt.1
Expand Up @@ -541,12 +541,20 @@ types are derived in a principal way. All programs accepted in
mode are also accepted in default mode with equivalent
types, but different binary signatures.
.TP
.B \-no\-principal
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 @@ -614,6 +622,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

0 comments on commit 9f1f71d

Please sign in to comment.