Skip to content

Document ocaml.local attribute on functions#2169

Merged
alainfrisch merged 1 commit intoocaml:trunkfrom
alainfrisch:document_ocaml_local_attribute
Nov 28, 2018
Merged

Document ocaml.local attribute on functions#2169
alainfrisch merged 1 commit intoocaml:trunkfrom
alainfrisch:document_ocaml_local_attribute

Conversation

@alainfrisch
Copy link
Copy Markdown
Contributor

In #2143 (which is merged), I forgot to document the new attribute.

Notes:

  • This section mixes different kinds of quotes (see http://caml.inria.fr/pub/docs/manual-ocaml/extn.html#sec260). One should normalize them, and I prefer the style I used in this PR, but perhaps others disagree so I did not apply any normalization here.
  • Missing documentation for @ocaml.unroll (mentioned in flambda.etex though).

@gasche
Copy link
Copy Markdown
Member

gasche commented Nov 28, 2018

You could point out that this optimization does not duplicate code or change code size, and explain why it is disabled when inlining hints are given (they supersede it).

@alainfrisch alainfrisch force-pushed the document_ocaml_local_attribute branch from 6440a65 to de99bd4 Compare November 28, 2018 16:03
@alainfrisch
Copy link
Copy Markdown
Contributor Author

Text modified as suggested, merging!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants