Skip to content

[cDAC] Rename datadescriptor.h -> datadescriptor.inc #118067

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 4 commits into from
Jul 28, 2025

Conversation

max-charlamb
Copy link
Contributor

Renames datadescriptor.h to datadescriptor.inl for upcoming PR allowing multiple contracts.

In the future datadescriptor.h will be included once for the actual #includes required by the datadescriptors and datadescriptor.inl will be included multiple times for processing.

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR renames the header file datadescriptor.h to datadescriptor.inl as part of preparation for future work enabling multiple contracts. The change is purely a file rename with corresponding include statement updates.

  • Updates all include statements from datadescriptor.h to datadescriptor.inl

@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Jul 25, 2025
@max-charlamb max-charlamb force-pushed the rename-datadescriptors branch from f89199e to 44074eb Compare July 25, 2025 20:23
@max-charlamb max-charlamb added area-Diagnostics-coreclr and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Jul 25, 2025
Copy link
Contributor

Tagging subscribers to this area: @steveisok, @dotnet/dotnet-diag
See info in area-owners.md if you want to be subscribed.

@risc-vv
Copy link

risc-vv commented Jul 25, 2025

@dotnet/samsung Could you please take a look? These changes may be related to riscv64.

@jkotas
Copy link
Member

jkotas commented Jul 25, 2025

.inl extension is typically used for files that contain implementations of inline functions. datadescriptor.h/inl is not that. I am not sure whether this rename is an improvement.

@max-charlamb
Copy link
Contributor Author

.inl extension is typically used for files that contain implementations of inline functions. datadescriptor.h/inl is not that. I am not sure whether this rename is an improvement.

I agree this isn't the best naming scheme. In order to reuse the datadescriptor mechanisms, I need to separate out the datadescriptor defines (which are imported multiple times) and the required includes.

Would you prefer keeping the datadescriptor defines in datadescriptor.h and having a separate header file for the includes?

@jkotas
Copy link
Member

jkotas commented Jul 25, 2025

To highlight that the file included multiple times is not an ordinary header file, I would use .inc suffix. For example, we do it here. verifylayouts.inc is the file included multiple times in this case. ChatGPT agrees: https://chatgpt.com/share/6883ff8c-14d8-8012-8c3e-437942296c75

(We also have a few places where we just use .h that's mildly confusing. For example, we do that here and here. metasig.h is the file included multiple times in this case.)

@jkotas
Copy link
Member

jkotas commented Jul 25, 2025

For stitching of multiple data contracts together (I assume that you need it for the GC), it may be useful to start with a spec edit (https://github.com/dotnet/runtime/blob/main/docs/design/datacontracts/datacontracts_design.md and linked docs) and agree on the details before you are done with the implementation.

@max-charlamb max-charlamb force-pushed the rename-datadescriptors branch from 44074eb to 6010ab0 Compare July 28, 2025 13:01
@max-charlamb max-charlamb changed the title [cDAC] Rename datadescriptor.h -> datadescriptor.inl [cDAC] Rename datadescriptor.h -> datadescriptor.inc Jul 28, 2025
@max-charlamb max-charlamb merged commit 9df2042 into dotnet:main Jul 28, 2025
98 checks passed
@max-charlamb max-charlamb deleted the rename-datadescriptors branch July 28, 2025 16:24
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.

4 participants