Fix several warnings and reduce Rust target clobbering #1069
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
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
rcoh
approved these changes
Jan 13, 2022
| * Rustdoc doesn't support `r#` for raw identifiers. | ||
| * This function adjusts doc links to refer to raw identifiers directly. | ||
| */ | ||
| fun docLink(docLink: String): String = docLink.replace("::r##", "::").replace("::r#", "::") |
There was a problem hiding this comment.
there may be other places where we make doc links that need to be audited (but maybe those aren't dynamic?)
Nevermind, looks like you got em
|
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
|
This was referenced Jan 14, 2022
Merged
2 tasks
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.
Motivation and Context
The protocol test output had several warnings in it, one of which was called out in #1040. Additionally, local development has involved a lot of recompiling of Rust dependencies lately due to clobbering of the
target/directory due to Gradle targets invoking Rust with different compiler flags.This PR addresses both issues and stops short of disallowing warnings from Rustdoc, which isn't quite possible until we implement #1068.
These changes should also make the license header lint run faster since it will recompile the tool less frequently.
Note: One protocol test Rustdoc warning is left in place since it didn't seem worth the effort to fix right now. This is a warning about the
crate::modelmodule not existing. There's a doc link to this module, but the module doesn't get generated if there are no structs or enums that would be placed in it (which is determined by the Smithy model). We could fix this by always producing an empty module in the future.Testing
codegen-test:checkfollowed byaws:sdk:assemblefollowed bycodegen-test:checkand verified that it didn't recompile all dependencies for the lastcodegen-test:checkinvocation.Checklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.