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

v0.6.3 release? #217

Closed
japaric opened this issue May 19, 2020 · 12 comments
Closed

v0.6.3 release? #217

japaric opened this issue May 19, 2020 · 12 comments
Assignees

Comments

@japaric
Copy link
Member

japaric commented May 19, 2020

Did anything breaking land in master since the v0.6.2 release?

I would like to see a v0.6.x release that includes binary-level fixes like #212 and #216

@Disasm
Copy link
Member

Disasm commented May 19, 2020

There was a breaking change since v0.6.2: #190

@little-arhat
Copy link

0.6.2 no longer works in nightly (rustc 1.46.0-nightly (118b50524 2020-06-06)) due to asm! deprecation (was fixed in #204).

@jonas-schievink
Copy link
Contributor

It should still work without the unstable inline-asm feature

@little-arhat
Copy link

@jonas-schievink

When this feature is enabled the implementation of all the functions inside the asm and register modules use inline assembly (asm!) instead of external assembly (FFI into separate assembly files pre-compiled using arm-none-eabi-gcc). The advantages of enabling inline-asm are:

    Reduced overhead. FFI eliminates the possibility of inlining so all operations include a function call overhead when inline-asm is not enabled.

    Some of the register API only becomes available only when inline-asm is enabled. Check the API docs for details.

The disadvantage is that inline-asm requires a nightly toolchain.

Documentation doesn't say this feature is unstable.

@adamgreig
Copy link
Member

I think we should start looking in to a 0.6.3 release with only the non-breaking changes and probably a 0.7.0 series with the breaking changes; as far as I'm aware the breaking PRs since 0.6.2 are #180 #181 #190 #191 #192 #193.

@kanishkarj
Copy link

It would be really great if 0.6.3 comes out soon. I want to actually publish a crate but the docs don't build because it uses the latest nightly. And it is not possible on the latest nightly like @little-arhat pointed out.

@jonas-schievink jonas-schievink self-assigned this Jul 19, 2020
@jonas-schievink
Copy link
Contributor

I'll take this on

@adamgreig
Copy link
Member

0.6.3 is now published 🎉

@kanishkarj
Copy link

Thanks a lot!!

@hug-dev
Copy link
Contributor

hug-dev commented Jul 20, 2020

Thanks for the release!

A small question: the cmse module does not seem to appear in the docs. Is that because it is behind the armv8m feature?

@adamgreig
Copy link
Member

Ah, that's annoying, yes that will be why. We should add a docs.rs metadata section to our Cargo.toml and perhaps a new doc feature to enable all modules when building for docs.rs. Though in some cases we include conflicting structs depending on architecture, so only one of those can be shown to docs.rs, which is kind of a pain...

@hug-dev
Copy link
Contributor

hug-dev commented Jul 20, 2020

Maybe showing the latest and greatest architecture is a good idea as it will most probably include all previous architecture features? For example that would be armv8m_main and has_fpu today?
The bad thing is that it will also show code that is not compiled for some architectures but imo that is better than not showing the code compiled in some others 😃.

bors bot added a commit that referenced this issue Aug 23, 2020
256: Add embedded targets to docs.rs r=jonas-schievink a=hug-dev

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](#217 (comment)) and the `cmse` module.

docs.rs now allows building for specific target and since [this PR](rust-lang/docs.rs#633) even for targets available via `rustup`!

The `stm32f3_discovery` crate does it, look at ["Platform" on docs.rs](https://docs.rs/stm32f3-discovery/0.4.0/stm32f3_discovery/index.html).

So I think it would be very neat to have on `cortex-m` and 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.

Co-authored-by: Hugues de Valon <[email protected]>
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

No branches or pull requests

7 participants