From 9f1f71d0c2aa86ddc77d4243af234606f23f2767 Mon Sep 17 00:00:00 2001 From: Nangah Amandine Date: Fri, 21 Oct 2022 15:42:51 +0100 Subject: [PATCH] Documentation: Added negative options to manpages (#11647) --- Changes | 7 ++++--- man/ocaml.1 | 12 ++++++++++++ man/ocamlc.1 | 12 ++++++++++++ man/ocamlopt.1 | 12 ++++++++++++ 4 files changed, 40 insertions(+), 3 deletions(-) diff --git a/Changes b/Changes index 4f8e2cc384ad..afab7a09e0d0 100644 --- a/Changes +++ b/Changes @@ -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: diff --git a/man/ocaml.1 b/man/ocaml.1 index 09b435835506..2f260c49ff68 100644 --- a/man/ocaml.1 +++ b/man/ocaml.1 @@ -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 , @@ -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 diff --git a/man/ocamlc.1 b/man/ocamlc.1 index ac1ba1e1ab52..49a62ff8a171 100644 --- a/man/ocamlc.1 +++ b/man/ocamlc.1 @@ -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 @@ -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 diff --git a/man/ocamlopt.1 b/man/ocamlopt.1 index 838c99167296..859c9f1a1656 100644 --- a/man/ocamlopt.1 +++ b/man/ocamlopt.1 @@ -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 @@ -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