Skip to content
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

Sign the Microsoft.Windows.Sdk.Win32Docs.dll assembly #1380

Merged
merged 2 commits into from
Nov 23, 2022

Conversation

AArnott
Copy link
Member

@AArnott AArnott commented Nov 22, 2022

We need to build it, sign it, then pack it.

We need to build it, sign it, then pack it.
@AArnott
Copy link
Member Author

AArnott commented Nov 22, 2022

I've verified that the dll is now signed, and that the docs package gets a new version so that it will actually push.

@mikebattista mikebattista merged commit 0e77676 into main Nov 23, 2022
@mikebattista mikebattista deleted the signWin32DocsAssembly branch November 23, 2022 03:41
@riverar
Copy link
Collaborator

riverar commented Nov 28, 2022

What's the new assembly for?

@AArnott
Copy link
Member Author

AArnott commented Nov 28, 2022

What new assembly? This change doesn't introduce a new assembly. It just signs an existing one.
If you're wondering what Microsoft.Windows.Sdk.Win32docs.dll is for, it just defines the schema for the apidocs.msgpack file.

@riverar
Copy link
Collaborator

riverar commented Nov 28, 2022

Ah neat, thanks. Wasn't familiar with this assembly.

@timsneath
Copy link
Contributor

@AArnott is it documented somewhere by any chance?

@AArnott
Copy link
Member Author

AArnott commented Jan 3, 2023

@timsneath Not that I know of, but that would only be due to lack of time. This package is meant for consumption by any other projection.

@timsneath
Copy link
Contributor

Is it used by another projection like C#? If there's some existing code that could act as a breadcrumb trail for me to follow, I'd appreciate anything you can offer!

@AArnott
Copy link
Member Author

AArnott commented Jan 3, 2023

@timsneath, breadcrumb follows:

  1. note the nuget dependency from my projection to the docs package. See also source. This package contains both the assembly that defines the schema and the msgpack docs content itself.
  2. How I deserialize the docs file. ApiDetails is the type defined within the Microsoft.Windows.Sdk.Win32Docs.dll assembly. I find the file to deserialize via an msbuild property that is set here based on an msbuild item that is defined by the docs package itself.
  3. How I actually produce the source doc comments in the emitted code.

@timsneath
Copy link
Contributor

Thanks Andrew! I'll take a look.

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.

4 participants