Add most common `windows-bindgen` options to readme

[kennykerr]

Originally posted by @kennykerr in #3510_

[MarijnS95]

That'd be awesome. I was just going over another crate migration to windows-bindgen and noticed that I had to backtrack from the library documentation on windows-bindgen all the way to the 0.61 release tag to find #3359 again which documents all the new options.

Would be awesome if that could be copy-pasted into docs.rs 👍

[github-actions]

This issue is stale because it has been open 10 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[MarijnS95]

@kennykerr has anything materialized here? Specifically, I'm curious if there's an option to generate bindings that point into windows-strings (for P(C)STR & co) which currently point to windows-core, but not sure how to set that up with --reference.

I expected something like --reference windows_strings,skip-root,Windows.Win32.Foundation.PCSTR but it can't find PCSTR in that namespace (and ilspy only shows PSTR there...?).

[kennykerr]

Been a little busy but you can get a summary of the options here: #3359

windows-bindgen assumes windows-core for the string types, but it probably makes more sense to generate those as direct dependencies on windows-strings. Just for context, is there a reason you'd like to avoid the windows-core dependency?

[MarijnS95]

That's the PR I had been looking at, but iirc some things changed since (--no-deps is new iirc, and not documented there).

I don't necessarily need to get rid of windows-core, but a vocal minority at iana-time-zone wants it (requiring use of more complicated and less portable APIs while at it).

Perhaps having a mode where we can pick which crate to use would be useful. For example, --no-deps + --sys generates bindings against windows-link with an MSRV of 1.71. If I want to opt out of that by removing --no-deps to go back to windows-targets dependencies, the PCSTR typedef is replaced with windows_sys::core::PCSTR too :)

[kennykerr]

#3450 added the --link option that you can use to control whether it uses windows-link, windows-targets, or something else.

The strings are a bit more complicated but I'll give that some more thought.

[MarijnS95]

Thanks, that's exactly what I need! Looks like it's available in both windows-bindgen 0.60 and 0.61 too 👍

[kennykerr]

Sorry for the delay: #3617

[MarijnS95]

Hey @kennykerr, is any documentation available on how to replace a windows-core dependency with windows-result (the code I'm generating only references windows_core::Result)? Likewise, it was possible to ask the generator to inline BOOL too, right?

I feel like I've asked both questions before, but can no longer find them nor the answers. Thanks! 🙏