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.

Sign up for GitHub

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

Jump to bottom

Documentation: Added options and negative options to manpages #11647

Merged
merged 13 commits into from Oct 21, 2022
Merged

Documentation: Added options and negative options to manpages #11647

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
53d3a52
Documentation: Added Flambda Commonly-used options to man file
nangahamandine Oct 18, 2022
51406b1
Merge branch 'trunk' of https://github.com/amaluxx/ocaml into trunk
nangahamandine Oct 19, 2022
b70dd40
Merge branch 'ocaml:trunk' into trunk
nangahamandine Oct 19, 2022
ac922dc
Documentation: Added missing negative options to man files
nangahamandine Oct 19, 2022
90c004d
Documentation: Added missing negative options to man files
nangahamandine Oct 19, 2022
24f35c0
Documentation: Added missing option and negative options to man files
nangahamandine Oct 19, 2022
a29afb9
Documentation: Added missing negative options to man files
nangahamandine Oct 20, 2022
580b260
Documentation: Added missing negative options to man files
nangahamandine Oct 20, 2022
d98420f
Documentation: Added missing negative options to man files
nangahamandine Oct 20, 2022
6cf7e88
Documentation: Added missing negative options to man files
nangahamandine Oct 20, 2022
afe4508
Documentation: Added missing negative options to man files
nangahamandine Oct 20, 2022
2a78171
Documentation: Added missing negative options to man files
nangahamandine Oct 21, 2022
e2df170
Documentation: Added missing negative options to man files
nangahamandine Oct 21, 2022
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
14 changes: 1 addition & 13 deletions man/ocaml.1
View file
Open in desktop
Expand Up @@ -165,8 +165,7 @@ use it once before publishing source code.
.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.
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.
Expand Down Expand Up @@ -199,17 +198,6 @@ Force the left-hand part of each sequence to have type unit.
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.B \-strict\-formats
Reject invalid formats that were accepted in legacy format
implementations. You should use this flag to detect and fix
such invalid formats, as they will be rejected by future
OCaml versions.
.TP
.B \-no-strict\-formats
Do no reject invalid formats that were accepted in legacy format
implementations.
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
14 changes: 1 addition & 13 deletions man/ocamlc.1
View file
Open in desktop
Expand Up @@ -627,8 +627,7 @@ This is the default.
.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.
are supported.
.TP
.B \-no-rectypes
Do no allow arbitrary recursive types during type-checking.
Expand Down Expand Up @@ -673,17 +672,6 @@ Force the left-hand part of each sequence to have type unit.
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.B \-strict\-formats
Reject invalid formats that were accepted in legacy format
implementations. You should use this flag to detect and fix
such invalid formats, as they will be rejected by future
OCaml versions.
.TP
.B \-no-strict\-formats
Do no reject invalid formats that were accepted in legacy format
implementations.
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
63 changes: 24 additions & 39 deletions man/ocamlopt.1
View file
Open in desktop
Expand Up @@ -547,8 +547,7 @@ This is the default.
.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.
are supported.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note should neither be removed from ocamlc.1 and ocamlopt.1 nor added to ocaml.1.

.TP
.B \-no-rectypes
Octachron marked this conversation as resolved.
Show resolved Hide resolved
Do no allow arbitrary recursive types during type-checking.
Expand Down Expand Up @@ -625,17 +624,6 @@ The left-hand part of a sequence must have type unit.
Left-hand part of a sequence need not have type unit.
This is the default.
.TP
.B \-strict\-formats
Reject invalid formats that were accepted in legacy format
implementations. You should use this flag to detect and fix
such invalid formats, as they will be rejected by future
OCaml versions.
.TP
.B \-no-strict\-formats
Do no reject invalid formats that were accepted in legacy format
implementations.
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 Expand Up @@ -761,6 +749,29 @@ compilation times and code that probably runs rather slower.
Emit .inlining files (one per round of optimisation) showing all of the
inliner's decisions.

.SH OPTIONS THE FOR FLAMBDA MIDDLE-END

When the Flambda code generator has been enabled at configuration time,
its behavior may be tuned up with the following additional options:
.TP
.B \-02
Perform more optimisation than usual. Compilation times may be lengthened.
.TP
.B \-03
Perform even more optimisation than usual, possibly including unrolling of
recursive functions. Compilation times may be significantly lengthened.
.TP
.B \-Oclassic
Makes inlining decisions at the point of definition of a function rather than
at the call site(s). This mirrors the behaviour of OCaml compilers not using
Flambda. Compared to compilation using the new Flambda inlining heuristics
(for example at -O2) it produces smaller .cmx files, shorter compilation times
and code that probably runs rather slower.
.TP
.B \-inlining-report
Emit .inlining files (one per round of optimisation) showing all of the
inliner's decisions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is now repeated twice at the same location, you should remove it.

.SH OPTIONS FOR THE IA32 ARCHITECTURE

The IA32 code generator (Intel Pentium, AMD Athlon) supports the
Expand Down Expand Up @@ -798,32 +809,6 @@ Generate position-independent machine code. This is the default.
.B \-fno\-PIC
Generate position-dependent machine code.

.SH OPTIONS FOR FLAMBDA

The Flambda code generator supports the following additional options:
.TP
.B \-02
Perform more optimisation than usual. Compilation times may be lengthened.
.TP
.B \-03
Perform even more optimisation than usual, possibly including unrolling of
recursive functions. Compilation times may be significantly lengthened.
.TP
.B \-Oclassic
Makes inlining decisions at the point of definition of a function rather than
at the call site(s). This mirrors the behaviour of OCaml compilers not using
Flambda. Compared to compilation using the new Flambda inlining heuristics
(for example at -O2) it produces smaller .cmx files, shorter compilation times
and code that probably runs rather slower. When using -Oclassic, only the
following options described in this section are relevant: -inlining-report
and -inline. If any other of the options described in this section are used,
the behaviour is undefined and may cause an error in future versions of
the compiler.
.TP
.B \-inlining-report
Emit .inlining files (one per round of optimisation) showing all of the
inliner’s decisions.

.SH OPTIONS FOR THE POWER ARCHITECTURE

The PowerPC code generator supports the following additional options:
Expand Down