Add embedded targets to docs.rs #256
Merged
Conversation
This file contains hidden or 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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
S-waiting-on-review
Cargo.toml
Outdated
Comment on lines
24
to
30
| targets = ["thumbv8m.main-none-eabihf", | ||
| "thumbv6m-none-eabi", | ||
| "thumbv7em-none-eabi", | ||
| "thumbv7em-none-eabihf", | ||
| "thumbv7m-none-eabi", | ||
| "thumbv8m.base-none-eabi", | ||
| "thumbv8m.main-none-eabi" |
There was a problem hiding this comment.
Suggested change
| targets = ["thumbv8m.main-none-eabihf", | |
| "thumbv6m-none-eabi", | |
| "thumbv7em-none-eabi", | |
| "thumbv7em-none-eabihf", | |
| "thumbv7m-none-eabi", | |
| "thumbv8m.base-none-eabi", | |
| "thumbv8m.main-none-eabi" | |
| targets = [ | |
| "thumbv8m.main-none-eabihf", | |
| "thumbv6m-none-eabi", | |
| "thumbv7em-none-eabi", | |
| "thumbv7em-none-eabihf", | |
| "thumbv7m-none-eabi", | |
| "thumbv8m.base-none-eabi", | |
| "thumbv8m.main-none-eabi", |
hug-dev
force-pushed
the
new_docs_target
branch
from
7ba20b0 to
398de5c
Compare
Signed-off-by: Hugues de Valon <[email protected]>
hug-dev
force-pushed
the
new_docs_target
branch
from
398de5c to
51dfa4d
Compare
|
Build succeeded: |
|
Could a quick patch release be done for that to be up on |
Hopefully we can get 0.7 out soon which will include this. |
robyoung
added a commit
to robyoung/volatile-register
that referenced
this pull request
Aug 9, 2021
Since rust-embedded/cortex-m#256 (released in v0.7) the docs links from cortex-m to this crate link to the target specific version. As these targets are not included on this crate the links fail. For example; see the links to RO on this page https://docs.rs/cortex-m/0.7.3/cortex_m/peripheral/cpuid/struct.RegisterBlock.html
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.
Some modules of this repo are gated by the various targets and hence docs.rs does not show the documentation for them! Like the Armv8-M ones for example and the
cmsemodule.docs.rs now allows building for specific target and since this PR even for targets available via
rustup!The
stm32f3_discoverycrate does it, look at "Platform" on docs.rs.So I think it would be very neat to have on
cortex-mand I proposing to add the following targets. The first one will show by default, I choosed the latest and greatest for that 😄I tested locally with
cargo doc --target ...for all of them.