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

.mli of compiler files should be installed too #5641

Closed
vicuna opened this issue Jun 8, 2012 · 4 comments
Closed

.mli of compiler files should be installed too #5641

vicuna opened this issue Jun 8, 2012 · 4 comments

Comments

@vicuna
Copy link

vicuna commented Jun 8, 2012

Original bug ID: 5641
Reporter: @zoggy
Status: resolved (set by @xavierleroy on 2012-06-17T08:25:38Z)
Resolution: suspended
Priority: normal
Severity: minor
Version: 4.00.0+beta2/+rc1
Category: configure and build/install
Monitored by: mww @glondu @hcarty

Bug description

It would be useful and convenient to install the .mli of the modules being installed in compiler-libs.

@vicuna
Copy link
Author

vicuna commented Jun 9, 2012

Comment author: @bobzhang

it's not necessary. since you can use ocamlbuild to dump the .inferred.mli

@vicuna
Copy link
Author

vicuna commented Jun 13, 2012

Comment author: @alainfrisch

IMO, the goal of installing compiler-libs is to allow end-users to compile third-party packages that depend on those compiler modules (for instance, some code base analysis tools). Developers of such tools could use .mli files as documentation (technically, they don't need them to compile their work), but one could argue that the .mli files of the compiler don't contain a lot of information, and that developers would actually like to have access to the implementation as well. And I think this is fine: developers of low-level tools, strongly tied to the compiler, will download the source code as a reference.

But if the demand is strong enough, I'm not opposed to installing .mli files.

@vicuna
Copy link
Author

vicuna commented Jun 17, 2012

Comment author: @xavierleroy

I agree with Alain Frisch's comment. The .mli of the compiler are not (by a long shot) written in a way that would document the compiler internals. I don't see added value in installing them.

@vicuna vicuna closed this as completed Jun 17, 2012
@vicuna
Copy link
Author

vicuna commented Jun 18, 2012

Comment author: @bobzhang

For curiosity, is there any public docs(whether in French or English) about the compiler internals?
Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant