Skip to content

Document shift-left Win32 metadata annotation proposal - #2295

Draft
Jevan Saks (jevansaks) wants to merge 2 commits into
microsoft:mainfrom
jevansaks:user/jevansa/shift-left-annotation-spec
Draft

Document shift-left Win32 metadata annotation proposal#2295
Jevan Saks (jevansaks) wants to merge 2 commits into
microsoft:mainfrom
jevansaks:user/jevansa/shift-left-annotation-spec

Conversation

@jevansaks

Copy link
Copy Markdown
Member

Summary

  • add the reviewed shift-left Win32 metadata annotation specification
  • add the HTML gap-review presentation used for the team walkthrough
  • document windows-rs fidelity issues that require tooling changes rather than SDK header changes
  • document the confirmed header families omitted by the original monolithic windows-rs scrape

Key decisions captured

  • use SAL-style casing with an owned _Win32_ prefix, such as _Win32_Retval_ and _Win32_Retained_
  • place return-oriented annotations before the complete function declaration
  • reuse existing SAL and MIDL semantics where available
  • remove ProjectAs from the proposed vocabulary and consolidate exact-result behavior under _Win32_Preserve_result_
  • retain raw HANDLE declarations and put lifecycle metadata only on producer returns and output parameters

This PR is documentation-only and is intended as the review package for the SDK and windows-rs design discussion.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 78d1f91d-a6a2-4264-b049-36c8d156ac9d
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 78d1f91d-a6a2-4264-b049-36c8d156ac9d
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.

1 participant