Documentation: Added options and negative options to manpages #11647
Conversation
nangahamandine
changed the title
man/ocaml.1
Outdated
| .B \-no-strict\-formats | ||
| Do no reject invalid formats that were accepted in legacy format | ||
| implementations. | ||
| This is the default. |
There was a problem hiding this comment.
Main options should be sorted by alphabetical order, thus strict-format should be just before strict-sequence.
man/ocaml.1
Outdated
| 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. |
There was a problem hiding this comment.
I would rather have this change in a separate PR because the text in the development branch and in the 5.0 branch needs to be different.
There was a problem hiding this comment.
Would you like me to remove the changes made in the ocaml.1 file and change back it to the default?
There was a problem hiding this comment.
I was speaking of the -strict-format and -no-strict-format change rather than the changes in ocaml.1.
There was a problem hiding this comment.
Oh alright. So I'll need to take out the -strict-format and -no-strict-format changes made in all three files for now and later create a separate PR to add the changes, right?
There was a problem hiding this comment.
Indeed. Moreover you would need to have one version of the PR for the 5.0 branch and another for the trunk branch because -strict-format is now the default on the trunk branch.
man/ocaml.1
Outdated
| @@ -165,7 +165,12 @@ 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. | |||
| are supported. Note that once you have created an interface using this | |||
| flag, you must use it again for all dependencies. | |||
There was a problem hiding this comment.
The REPL does not really create interface that are reused by other users. It seems better to keep this note out of this specific description.
man/ocamlopt.1
Outdated
| .B \-inlining-report | ||
| Emit .inlining files (one per round of optimisation) showing all of the | ||
| inliner’s decisions. | ||
|
|
There was a problem hiding this comment.
This spurious change is here because you created this branch from the first version of your previous PR, before we moved the location of the flambda section. To remove this change, you can either try to rebase your branch on trunk or remove this change by hand in a commit (that will disappear when this PR is squashed into a single commit).
|
Are the recent changes for this PR okay |
man/ocamlopt.1
Outdated
| .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. | ||
| are supported. |
There was a problem hiding this comment.
This note should neither be removed from ocamlc.1 and ocamlopt.1 nor added to ocaml.1.
man/ocamlopt.1
Outdated
| .B \-inlining-report | ||
| Emit .inlining files (one per round of optimisation) showing all of the | ||
| inliner's decisions. | ||
|
|
There was a problem hiding this comment.
This section is now repeated twice at the same location, you should remove it.
There was a problem hiding this comment.
This looks good, thanks!
You still need to add a Change entry. I would suggest that you merge the entry with the one from the previous PR:
- #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)
|
Can I go ahead to create another PR for the other changes? I was waiting for approval before making other changes |
|
You can certainly start working on another PR. You might want to try your hand at a non-documentation issue (maybe #11127 ?). |
|
Okay, thanks |
|
It would be a better use of your application period to try your hand at more challenging tasks. |
|
Okay then |
|
Merged, thanks again! |
Updated the ocamlopt.1, ocaml.1 and ocamlc.1 files with missing negative options in man directory