PR#7007, PR#7311: document OCAMLPARAM and ocaml_compiler_internal_params#879
Conversation
…iler_internal_params
manual/manual/cmds/comp.etex
Outdated
|
|
||
| \noindent | ||
| On native Windows, the following environment variable is also consulted: | ||
| \paragraph{contextual control of command-line options} |
manual/manual/cmds/comp.etex
Outdated
|
|
||
| The compiler command line can be modified ``from the outside'' | ||
| with the following mechanisms. These are experimental | ||
| and subject to change, and they are not intended for normal use. |
There was a problem hiding this comment.
What about "and subject to change. They should be used only for experimental and development work---never in released packages." ?
| configured value. Primarily used for bootstrapping. | ||
| \end{options} | ||
|
|
||
| \section{Common errors} |
There was a problem hiding this comment.
Can we "include" this section from a separate file maybe?
There was a problem hiding this comment.
There's a lot of duplicate text between comp.etex and native.etex. Factoring it out may be a good idea, but I won't attempt it in this PR.
There was a problem hiding this comment.
Concerning the duplication between comp.etex and native.etex, I had proposed to merge these files together (with top.etex) and handle the differences with tex macros in #491 . If there are some interests in this solution, I could rebase this PR; or create a version merging only comp.etex and native.etex − which would decrease the complexity of the resulting tex file.
alainfrisch
left a comment
There was a problem hiding this comment.
Looks good to me. I don't think that the information is enough to use either ocaml_compiler_internal_params or OCAMLPARAM, but the text carry the intented message ("do not use!").
manual/manual/cmds/comp.etex
Outdated
|
|
||
| \noindent | ||
| On native Windows, the following environment variable is also consulted: | ||
| \paragraph{contextual control of command-line options} |
There was a problem hiding this comment.
I would use a capitalized title here ("Contextual").
|
+1 - looks good to me |
|
That's a good minimal first step. As a user when reading this documentation I would have liked to see examples of the syntax, with the following questions in mind:
|
|
@gasche The idea (for the moment) is to document their existence so that users who see their compiler behaving weirdly will have a chance to figure out what is going on. Do you agree to merge this minimal first step for 4.04, then work on expanding the documentation in trunk? |
|
Yep, sure. |
* Sort books at build * Formatting --------- Co-authored-by: Cuihtlauac ALVARADO <cuihtmlauac@tarides.com>
Here is my first draft. Comments and suggestions are welcome.