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

Added description of -opaque to man pages. #633

Closed
wants to merge 1 commit into
base: trunk
from

Conversation

Projects
None yet
3 participants
@const-rs
Contributor

const-rs commented Jun 22, 2016

Man pages for ocamlc and ocamlopt didn't mention -opaque. I added short explanation.

@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Jun 26, 2016

Member

Do I understand correctly that -opaque is not mentioned in the manual either?

There are two different mode of uses of -opaque and your proposed wording mixes them up together.

  • when compiling an implementation, -opaque produces a .cmx without cross-module optimization information (as the -help output mentions, it may be good to point out that this is meant to avoid recompilation of dependencies when the implementation changes)
  • when compiling an interface, this marks the fact that its implementation is opaque; its dependencies will not look for a .cmx file and thus not warn if there is none
Member

gasche commented Jun 26, 2016

Do I understand correctly that -opaque is not mentioned in the manual either?

There are two different mode of uses of -opaque and your proposed wording mixes them up together.

  • when compiling an implementation, -opaque produces a .cmx without cross-module optimization information (as the -help output mentions, it may be good to point out that this is meant to avoid recompilation of dependencies when the implementation changes)
  • when compiling an interface, this marks the fact that its implementation is opaque; its dependencies will not look for a .cmx file and thus not warn if there is none
@const-rs

This comment has been minimized.

Show comment
Hide comment
@const-rs

const-rs Jun 27, 2016

Contributor

A. > Do I understand correctly that -opaque is not mentioned in the manual either?

Exactly. You can check it by running grep -r opaque manual

B. Great - would you please add this to man page? ;-) (for both compilers - ocamc and ocamlopt)

Contributor

const-rs commented Jun 27, 2016

A. > Do I understand correctly that -opaque is not mentioned in the manual either?

Exactly. You can check it by running grep -r opaque manual

B. Great - would you please add this to man page? ;-) (for both compilers - ocamc and ocamlopt)

@xavierleroy

This comment has been minimized.

Show comment
Hide comment
@xavierleroy

xavierleroy Dec 4, 2016

Contributor

Any volunteers for updating the manual in addition to the man pages?

Contributor

xavierleroy commented Dec 4, 2016

Any volunteers for updating the manual in addition to the man pages?

@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Dec 4, 2016

Member

Woops, sorry for letting this one slide by. I guess that the responsibility for documenting this is one me, given that I implemented this option in the first place. I won't have time to do it today or in the first half of the next week, but I consider myself assigned. (Of course any contribution to do it in my stead is welcome.)

Member

gasche commented Dec 4, 2016

Woops, sorry for letting this one slide by. I guess that the responsibility for documenting this is one me, given that I implemented this option in the first place. I won't have time to do it today or in the first half of the next week, but I consider myself assigned. (Of course any contribution to do it in my stead is welcome.)

@gasche gasche self-assigned this Dec 4, 2016

@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Dec 13, 2016

Member

So I wrote documentation in the manual and refined the manpage information. It is in my local branch gasche/ocaml#opaque-manual. I plan to merge after the merge of 4.04 into trunk is concluded.

Member

gasche commented Dec 13, 2016

So I wrote documentation in the manual and refined the manpage information. It is in my local branch gasche/ocaml#opaque-manual. I plan to merge after the merge of 4.04 into trunk is concluded.

@gasche

This comment has been minimized.

Show comment
Hide comment
@gasche

gasche Dec 27, 2016

Member

Subsumed by #989.

Member

gasche commented Dec 27, 2016

Subsumed by #989.

@gasche gasche closed this Dec 27, 2016

@gasche gasche referenced this pull request Dec 27, 2016

Merged

Opaque manual #989

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