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.

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

Document ocaml_compiler_internal_params #7311

Closed
vicuna opened this issue Aug 1, 2016 · 2 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented Aug 1, 2016

Original bug ID: 7311
Reporter: @gasche
Assigned to: @damiendoligez
Status: closed (set by @damiendoligez on 2016-11-03T13:25:08Z)
Resolution: fixed
Priority: normal
Severity: text
Version: 4.03.0
Target version: 4.04.0 +dev / +beta1 / +beta2
Fixed in version: 4.04.0 +dev / +beta1 / +beta2
Category: documentation
Related to: #7007

Bug description

The file ocaml_compiler_internal_params introduced by

#428

is undocumented. Not knowing about it can make it difficult for users to properly debug an OCaml environment to understand where some options are coming from.

Additional information

Documentation should be added in the chapter "Batch compilation (ocamlc)", section "Options" (manual/manual/cmds/comp.etex), and also in "Native-code compilation" (manual/manual/cmds/native.etex).

@vicuna

This comment has been minimized.

Copy link
Author

commented Sep 8, 2016

Comment author: @gasche

I think it is a mistake to delay this PR ad infinitum. People introducing new features should document them. The documentation should go in the release introducing the feature, and we already slipped that (it was added in 4.03). I'm moving this back to 4.04+dev to make sure the issue is properly discussed/considered -- but if there is strong consensus to delay I won't oppose.

@vicuna

This comment has been minimized.

Copy link
Author

commented Oct 28, 2016

Comment author: @damiendoligez

See #879 #879

@vicuna vicuna closed this Nov 3, 2016

@vicuna vicuna added this to the 4.04.0 milestone Mar 14, 2019

@vicuna vicuna added the bug label Mar 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.