Skip to content

Improve layout history error message: better test coverage #1924

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

Merged
merged 32 commits into from
Nov 21, 2023

Conversation

alanechang
Copy link
Contributor

Add tests to cover all possible layout reason messages

@goldfirere
Copy link
Collaborator

Delegate review to @ncik-roberts.

Base automatically changed from aec/hiding-layout-history to layout-histories October 26, 2023 19:21
@alanechang alanechang force-pushed the aec/layout-msg-test-coverage branch from f2809da to bc38ff3 Compare October 27, 2023 17:43
@alanechang
Copy link
Contributor Author

Note to reviewer: This PR contains very little change to actual code (only removes a unused constructor With_constraint) and mainly focuses on adding tests. The new tests aim to cover every creation_reason constructor in layouts.ml and have their corresponding error message displayed. This goal is not fully achieved and it was difficult to generate code snippets to reach certain constructors. In those cases, either a comment is left explaining why this constructor is believed to be unreachable or a CR is attached.

How to review: For each reason constructor (noted in the comment above the test case), if an error message is present, check it's relevant to the constructor specified and the message content is helpful. If no error message is present, suggest potential test case to reach that constructor (don't think too hard on this, only do it if it's easy) or check the associate comment in place is reasonable.

@alanechang
Copy link
Contributor Author

This is ready for review again. Main changes that were made are:

  • some extra logic to get the missing cmi layout reason in more places (changes typing-missing-cmi-indirections/test.compilers.reference)

https://github.com/ocaml-flambda/flambda-backend/blob/9a0d3a4dc653955d3108d56dd0e076276c06fd07/ocaml/typing/layouts.ml#L937-L946

This also means backporting the score_reason function from #1943

  • adding a Path.t parameter to Unannotated_type_parameter
  • attaching a "Please notify the Jane Street compilers group" message to layout reasons that we believe to be unreachable
  • new test for Missing_cmi, fixed Default_type_layout test
  • various wording changes

@alanechang alanechang requested a review from goldfirere November 9, 2023 17:13
@goldfirere
Copy link
Collaborator

I have reviewed @alanechang's new commits. I thought the approach in one involving missing cmis wasn't great, and so took a different approach. Alan, could you review my three commits above? (I ended up doing this myself, starting last week and not realizing I would be unable to finish.) Then we can merge! Thanks.

@goldfirere
Copy link
Collaborator

I've reviewed the last two commits from @alanechang, which include a fix for a bug I introduced. (Thanks, Alan!) Is this ready to merge now?

@alanechang
Copy link
Contributor Author

@goldfirere The changes look good. Just an issue around setting missing_cmi in Violation.t. I pushed two new commits to both fix the issue and add tests.

@alanechang
Copy link
Contributor Author

Yes, it's ready to be merged now.

@goldfirere goldfirere merged commit 95dc0bd into layout-histories Nov 21, 2023
@goldfirere goldfirere deleted the aec/layout-msg-test-coverage branch November 21, 2023 21:06
alanechang added a commit to alanechang/flambda-backend that referenced this pull request Dec 27, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message
alanechang added a commit to alanechang/flambda-backend that referenced this pull request Dec 27, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts
alanechang added a commit to alanechang/flambda-backend that referenced this pull request Dec 27, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts
alanechang added a commit to alanechang/flambda-backend that referenced this pull request Dec 27, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts
alanechang added a commit to alanechang/flambda-backend that referenced this pull request Dec 27, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts
alanechang added a commit that referenced this pull request Dec 29, 2023
* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (#2144)

mark test file as reviewed

Improve layout history error message: review new messages (#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts

Layout histories: resolve rebase conflicts (#2197)

* get things to build

* test changes

* remove unused jkind reason

* fix formatting
goldfirere pushed a commit that referenced this pull request Dec 29, 2023
* Enable layout histories (#1823)

* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (#2144)

mark test file as reviewed

Improve layout history error message: review new messages (#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts

Layout histories: resolve rebase conflicts (#2197)

* get things to build

* test changes

* remove unused jkind reason

* fix formatting

* fix rebase conflicts

* fix format
lukemaurer pushed a commit to lukemaurer/flambda-backend that referenced this pull request Oct 23, 2024
* Enable layout histories (oxcaml#1823)

* enable display_histories

* accept test changes and mark them as unreviewed

* improve CR messages for unreviewed tests

---------

Co-authored-by: Alan Chang <[email protected]>

Remove duplicated creation_reasons from layout history error messages (oxcaml#1825)

* stop storing duplicates in creation_reasons

* accept test changes

* reduce to only displaying one creation reason

* accept test changes

* prefer other reasons over Concrete_creation

* accept test changes

* stop building history tree if flatten is enabled

* remove CR version

Co-authored-by: Richard Eisenberg <[email protected]>

* Add CR for assumption in combine_histories

Co-authored-by: Richard Eisenberg <[email protected]>

---------

Co-authored-by: Alan Chang <[email protected]>
Co-authored-by: Richard Eisenberg <[email protected]>

Improve layout history error message formatting and wording (oxcaml#1832)

* remove extra whitespace

* fix Unequal_var_layouts error fmt

* improve message wording

* fix spacing

* accept test changes

* grammar and phrasing

* test changes

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: add path field to Type_argument value_creation_reason (oxcaml#1834)

* add Path.t to Type_argument

* test changes

* add Imported_type_argument

* Imported_type_argument for imported type params

* fix float64 error format

* test changes

* add more tests

* update layout reason not just in failure case

* tests with more than one type param

* combine Imported_type_argument with Type_argument

* add option_argument_layout to predef

* track position and arity for Type_argument

* test changes

* more tests around typa argument arity

* have Imported_type_argument as a creation_reason

* test changes

* add note about performance benchmark

* extract position format logic into function

* add comments about 1-indexed

* change equals to is

* test changes

* define list_argument_layout

* format comments

---------

Co-authored-by: Alan Chang <[email protected]>

Improve layout history error message: additional info on value layout defaulting (oxcaml#1855)

* add message when defaulting to layout value

* test changes

* relax to all const defaulting

* test changes

* improve wording

* test changes

---------

Co-authored-by: alanechang <[email protected]>

Improve layout history error message: change message wording and add more tests (oxcaml#1887)

* change imported reason wording

* test changes

* lowercase

* test changes

* add more tests

* change wording for match

* update Immediate_polymorphic_variant message

* test changes

Improve layout history error message: hide layout history reason of various generalized vars (oxcaml#1889)

* add generalized creation reason

* use change layout reason for value decl

* change layout reason for decl type params

* test changes

* additional tests

* add "the"

* test changes

* improve generalize on type decl

* test changes

* update err msg test case

* add print_loc_in_lowercase

* test changes

* update_decls_layout_reason code cleanup

Improve layout history error message: better test coverage (oxcaml#1924)

* Annotation

* concrete layout

* value layout

* immediate layout

* float64 layout

* the rest

* fix probe test

* fix tests

* more changes

* more value test

* add note

* remove unused With_constraint constructor

* fix format

* remove unused void_creation_reason

* remove unused Value_kind

* add Missing_cmi test

* consistent names for Type_variable&Univar

* add param to Unannotated_type_parameter

* add CRs

* fix wording

* add warning to all reasons we can't produce

* more CRs

* fix formatting

* add new tests

* enhance creation reason when missing cmi

* fix Unannotated_type_parameter

* test changes

* code formatting (only)

* Record missing cmi in the layout history

* Add a CR

* add broken test

* fix is_missing_cmi check

---------

Co-authored-by: Richard Eisenberg <[email protected]>

Support for [@error_message] attribute on layout annotations (oxcaml#1943)

support for error_message attr on layout annots

add error_message to the builtin_attrs table

change error_message_attr to return first

refactor
- layout_of_annotation_or_attr to layout_of_annotation
- Err_msg_attr to With_error_message

fix tests

improve formatting

Support for [@error_message] attribute on Pexp_constraint (oxcaml#1954)

* implement error_message on Pexp_constraint

* add tests

* force message to be on new line

* fix typo

Improve layout history error message: omit history for signature mismatch (oxcaml#2089)

strip away layout history for signature mismatch

Layout history: mark `typing-immediate/immediate.ml` as reviewed (oxcaml#2144)

mark test file as reviewed

Improve layout history error message: review new messages (oxcaml#2091)

* remove layouts v2.9 CRs

* "must be representable" instead of var name

* catch missing history generalization

* add history to Bad_univar_layout

* remove crs

* Toplevel_nonvalue refer to types

* change Non_value_in_sig to refer to types

* fix typo of Polymorphic

* type argument to a class constructor

* change message of Not_a_value

* remove stale test file

* refer to types in all messages

* update unannotated universal variable message

* split into Class_type_argument&Class_term_argument

* add comment on update_generalized_ty_layout_reason

* undo change to Not_a_value

* update Not_a_value message

fix merge conflicts

Layout histories: resolve rebase conflicts (oxcaml#2197)

* get things to build

* test changes

* remove unused jkind reason

* fix formatting

* fix rebase conflicts

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

Successfully merging this pull request may close these issues.

3 participants