Provide individual crate readme files #2645
Merged
Conversation
This file contains 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
|
I can't post comments on the files directly, seems GitHub is slightly broken right now. Was just going to suggest maybe adding comments |
Added some comments. Let me know if that's what you had in mind. |
|
@kennykerr Looks fine to me, we can adjust per feedback if any further PRs mistakenly come in. |
ChrisDenton
approved these changes
Sep 5, 2023
bors
referenced
this pull request
in rust-lang/cargo
Dec 1, 2023
chore(deps): update rust crate windows-sys to 0.52 [](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [windows-sys](https://togithub.com/microsoft/windows-rs) | workspace.dependencies | minor | `0.48` -> `0.52` | --- ### Release Notes <details> <summary>microsoft/windows-rs (windows-sys)</summary> ### [`v0.52.0`](https://togithub.com/microsoft/windows-rs/releases/tag/0.52.0) [Compare Source](https://togithub.com/microsoft/windows-rs/compare/0.48.0...0.52.0) This release includes updates to all crates. This includes the first update to the `windows-sys` crate in 8 months. It also includes the first published version of the [riddle](https://crates.io/crates/riddle) tool and the [windows-version](https://crates.io/crates/windows-version) crate. #### What's Changed - Simplify issue templates by [`@​riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2621](https://togithub.com/microsoft/windows-rs/pull/2621) - Switch all crates to Rust edition 2021 by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2620](https://togithub.com/microsoft/windows-rs/pull/2620) - Correct workflow trigger ignore paths by [`@​riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2622](https://togithub.com/microsoft/windows-rs/pull/2622) - Detect unused `bindgen`/`riddle` filters by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2634](https://togithub.com/microsoft/windows-rs/pull/2634) - Fix `BOOLEAN` parameter binding by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2635](https://togithub.com/microsoft/windows-rs/pull/2635) - Provide individual crate readme files by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2645](https://togithub.com/microsoft/windows-rs/pull/2645) - Tweak Win32 error code conversion to handle `HRESULT` input by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2646](https://togithub.com/microsoft/windows-rs/pull/2646) - Remove support for the defunct `StaticLibrary` attribute by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2647](https://togithub.com/microsoft/windows-rs/pull/2647) - Derive `PartialEq`, `Eq`, `Debug`, `Clone` for interfaces by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2651](https://togithub.com/microsoft/windows-rs/pull/2651) - Internal `bindgen` refactoring by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2654](https://togithub.com/microsoft/windows-rs/pull/2654) - Disable signature transformation for `NTSTATUS` by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2658](https://togithub.com/microsoft/windows-rs/pull/2658) - Unhide `query` method on `ComInterface` trait by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2659](https://togithub.com/microsoft/windows-rs/pull/2659) - Harden `QueryInterface` implementation by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2660](https://togithub.com/microsoft/windows-rs/pull/2660) - Mask non-reproducible linker artifacts in libs by [`@​riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2661](https://togithub.com/microsoft/windows-rs/pull/2661) - Slim doc generation by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2671](https://togithub.com/microsoft/windows-rs/pull/2671) - Update SDK and WDK metadata by [`@​riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2664](https://togithub.com/microsoft/windows-rs/pull/2664) - Add feature documentation quotes by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2675](https://togithub.com/microsoft/windows-rs/pull/2675) - Add `docs` feature by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2676](https://togithub.com/microsoft/windows-rs/pull/2676) - Simplify metadata reader by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2682](https://togithub.com/microsoft/windows-rs/pull/2682) - Add bindgen config option to disable generating inner attributes by [`@​dpaoliello](https://togithub.com/dpaoliello)` in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683) - Simplify metadata filtering by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2684](https://togithub.com/microsoft/windows-rs/pull/2684) - Simplify code generation by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2686](https://togithub.com/microsoft/windows-rs/pull/2686) - Fix link from docs.rs to full API documentation by [`@​ChrisDenton](https://togithub.com/ChrisDenton)` in [https://github.com/microsoft/windows-rs/pull/2688](https://togithub.com/microsoft/windows-rs/pull/2688) - Optimize tick trimming by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2689](https://togithub.com/microsoft/windows-rs/pull/2689) - Small bindgen refactor and tools refresh by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2695](https://togithub.com/microsoft/windows-rs/pull/2695) - Document `implement` and `interface` macros by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2696](https://togithub.com/microsoft/windows-rs/pull/2696) - Perform checked integral type conversions for APIs by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2699](https://togithub.com/microsoft/windows-rs/pull/2699) - Add `windows-version` crate by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2702](https://togithub.com/microsoft/windows-rs/pull/2702) - Add crate-specific readme files by [`@​kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2703](https://togithub.com/microsoft/windows-rs/pull/2703) #### New Contributors - [`@​dpaoliello](https://togithub.com/dpaoliello)` made their first contribution in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683) **Full Changelog**: microsoft/windows-rs@0.48.5...0.52.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Up to now we've just provided a single readme shared by all crates. This has proven to be a simple and manageable approach but has also caused quite a bit of confusion for developers poking around the repo directly. In this update I've simply copied the readme into each individual library crate so they can evolve separately and removed most of the content from the repo's readme which can now also focus more on supporting developers visiting the repo itself. Hopefully this helps to avoid some of the confusion.
Fixes #2644 #2110 #1940 #780 #651 etc.
@tim-weis @ChrisDenton @riverar for suggestions.