-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Add cdac CCR instructions #128502
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
Open
rcj1
wants to merge
3
commits into
dotnet:main
Choose a base branch
from
rcj1:add-cdac-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add cdac CCR instructions #128502
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| applyTo: "src/native/managed/cdac/**" | ||
| --- | ||
|
|
||
| # cDAC — Folder-Specific Guidance | ||
|
|
||
| ## Preface | ||
|
|
||
| The instructions under `API Review`, `DacDbi interface` and `Dump compatibility` only apply if the SDK version in global.json is a preview, release candidate or otherwise a development branch of .NET 11. If this is a development branch of .NET 12 or later, you **MUST** ignore these three sections entirely. Check `global.json` before applying them. | ||
|
|
||
| ## API Review (.NET 11 dev branches only) | ||
|
|
||
| New APIs on implementations of IContract under the folder src/native/managed/cdac/Microsoft.Diagnostics.DataContractReader.Contracts/Contracts/** do **NOT** need to go through API review. **MUST NOT** describe such changes as "breaking" or "public API changes". | ||
|
rcj1 marked this conversation as resolved.
|
||
|
|
||
| ## DacDbi interface (.NET 11 dev branches only) | ||
|
|
||
| The DacDbi COM interface is **internal and unstable**. | ||
|
|
||
| - **MUST NOT** flag changes to DacDbi as breaking changes. | ||
| - **MUST NOT** warn about COM ABI compatibility, vtable ordering, or | ||
| GUID changes on DacDbi. | ||
|
rcj1 marked this conversation as resolved.
|
||
|
|
||
| ## Dump compatibility (.NET 11 dev branches only) | ||
|
|
||
| - **MUST NOT** raise concerns about older dumps lacking new data descriptors. | ||
| - **MUST NOT** request fallback paths, conditional reads, or versioning | ||
| shims for missing descriptors on the grounds of "supporting older dumps". | ||
|
|
||
| ## Exception types | ||
|
|
||
| When porting `HRESULT`-returning APIs to throw exceptions, the following mappings **MUST** be accepted: | ||
| - `ArgumentException` → for `E_INVALIDARG` | ||
| - `NullReferenceException` → for `E_POINTER` | ||
| - `InvalidCastException` → for `E_NOINTERFACE` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.