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
Synchronize option help in --help and man page #6955
Comments
Comment author: @gasche Here is the command I used to get the list of options listed in the manual (from the man/ directory of the source repository):
Here is the one to get the list of options listed in --help:
At the time of writing, the list of options mentioned in --help but not in the manual is the following: |
Comment author: @gasche This was ocamlc only. The situation is even worse for ocamlopt, with the following things missing from the manual: In the other direction, "ocamlopt -help" does not list versions not available on my architecture, so I see a list of arm-specific options: -farch |
@Octachron @gasche |
You certainly can, I would advise you to select a small thematic subset, for instance the flambda global optimisation |
@Octachron |
Only if the argument is used by ocamlc, in otherwords if it appears in |
So the options that are seen by running ocamlc --help should be added to the ocamlc.m if not already present. e.g. - let mk_alert f = "-alert", Arg.String f, Printf.sprintf " Enable or disable alerts according to :\n\ \ + enable alert \n\ \ - disable alert \n\ \ ++ treat as fatal error\n\ \ -- treat as non-fatal\n\ \ @ enable and treat it as fatal error\n\ \ can be 'all' to refer to all alert names";; |
This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc. |
This issue has been open one year with no activity. Consequently, it is being marked with the "stale" label. What this means is that the issue will be automatically closed in 30 days unless more comments are added or the "stale" label is removed. Comments that provide new information on the issue are especially welcome: is it still reproducible? did it appear in other contexts? how critical is it? etc. |
Hello, I'd like to work on this issue. Can you please brief me on how to go about it? I don't clearly understand what we're required to do |
There are two ways to get a list of flags for ocamlc and ocamlopt. One may either use the $ ocamlopt -help or one may read the
The two locations are currently slightly desynchronized. In particular, the man page entry for ocamlopt (man/ocamlopt.1) doesn't cover the |
Thank you for the guide, I'm a complete beginner in OCaml and contributing to open source in general so I find some difficulties navigating around everything. I'll try that and get back to you if I have any questions |
Hello, I have been trying to to run the 'man ocamlopt' command but I get an error saying "bash: man: command not found". I'm presently in the man folder but no success. The 'ocamlopt -help' command runs just fine. How do I resolve this please? |
Also, I'd like to clearly understand this. The flambda options described at https://v2.ocaml.org/manual/flambda.html#s:flambda-cli are required to be added to the ocamlopt.1 file in the man folder right? If so, how do I go about it please? If not, can you please enlighten me? |
You need to install the man executable. |
Thank you From the flambda options described in the documentation above, do I add the Commonly-used options, Less commonly-used options and Advanced options, only needed for detailed tuning? Or just the commonly used options? |
The commonly-used options are probably a good scope for a first PR. |
Okay thanks |
I'd like to continue working on this issue. Can you please suggest another subset for me to work on? |
There are few missing negative command lines,
Similarly, the option |
I do not clearly understand how to document these missing negative command lines. If you could please elaborate more, I'd be grateful |
You can start from the argument description provided by the command line:
|
I've noticed that the ocaml.1 file is missing these options too. Should I add them in it? |
You are right, you can also add those options to the |
This too is missing in the ocaml.1 manpage |
Yes, this is intentional: the |
Noted |
I understand that this issue was closed by merging #11647. Thanks again! |
Original bug ID: 6955
Reporter: @gasche
Status: acknowledged (set by @gasche on 2015-08-09T10:06:59Z)
Resolution: open
Priority: normal
Severity: text
Version: 4.03.0+dev / +beta1
Target version: 4.07.0+dev/beta2/rc1/rc2
Category: documentation
Tags: junior_job
Bug description
Some options are mentioned in --help but missing from the manpages, or not handled by OCAMLPARAM.
Additional information
It would be helpful to check the list of OCAMLPARAM-supported options to see if we have forgotten something else.
The text was updated successfully, but these errors were encountered: