Skip to content

Conversation

elbeno
Copy link
Contributor

@elbeno elbeno commented Sep 3, 2025

Problem:

  • combine is a generic name that doesn't contrast with pack and doesn't have a clear meaning.

Solution:

  • Change combine to overlay to make it clearer what the operation is.
  • Clarify documentation around overlay and pack
  • Add docs regarding relaxed_message.

Copy link
Contributor

@lukevalenty lukevalenty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like it!

as i was reading the documentation, it brought to mind the following "equivalencies":

  • overlay ~= union
  • concat ~= struct

Problem:
- `combine` is a generic name that doesn't contrast with `pack` and doesn't have
  a clear meaning.

Solution:
- Change `combine` to `overlay` to make it clearer what the operation is.
- Clarify documentation around `overlay` and `pack`
- Add docs regarding `relaxed_message`.
@elbeno elbeno force-pushed the clarify-message-combos branch from 0aa56f0 to dfeacd4 Compare September 3, 2025 17:11
@elbeno elbeno enabled auto-merge September 3, 2025 17:11
@elbeno elbeno merged commit c9b0b29 into intel:main Sep 3, 2025
27 checks passed
// resulting message layout:
// byte |0 |1 |
// bit |01234567|01234567|
// field |header |payload |
Copy link
Contributor

@mjcaisse-intel mjcaisse-intel Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: is data_f specified incorrectly above? Should it be:

using data_f = field<"data", std::uint32_t>::located<at{0_dw, 15_msb, 8_lsb}>;

optionally, if the intent is to show overlap the table can be rendered differently.

elbeno added a commit to elbeno/compile-time-init-build that referenced this pull request Sep 3, 2025
Problem:
- A field is incorrectly located.

Solution:
- Fix it.

Note:
- From intel#764 (comment)
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