[Fixes #72] Deal with dependencies to fix things, mostly doctests #73

michalfita · 2023-12-23T13:24:46Z

Purpose

Since Rust 1.60 it's possible to enable dependencies' features only for included dependencies.

That's going to work for rt and critical-section and some other features in future.

Scope

Workflow
Dependencies handling
Rename of internal features (prefix by __; idea stolen from another PAC/HAL project)

Since Rust 1.60 it's possible to enable dependencies' features only for included dependencies. That's going to work for `rt` and `critical-section` and some other features in future.

``` let pac = hal::pac::Peripherals::take().unwrap(); ``` instead of ``` let pac = hal::pac::Peripherals::take().unwrap(); ```

It would be nice to have a tool that extracts all basic check from workflow to be run before commit. Not working on machine I normally burn for this stuff has downsides, as I rush things...

michalfita · 2023-12-23T15:44:35Z

@martinmortsell This PR makes the whole CI 🟢 with steal() replaced back to take() in doctests.

In result we're more aligned with pattern svd2rust now counts on and which is in motion in other PACs and HAL crates.

This is braking change! There are no *-rt chip selection features any more, only rt feature to use.

A little scope creep: In the process I updated some dependencies and ended up with need to fix up how USB is used in the code, both doctests and examples. If you don't approve it, I can move them into another PR, and clean this one up from this change.

martinmortsell · 2023-12-23T16:17:19Z

I was gonna revert the steal/take switch myself. Thanks.

I'll look through the rest in the beginning of January.

michalfita · 2023-12-23T18:06:52Z

I was gonna revert the steal/take switch myself. Thanks.

Just revert wouldn't work. I spend quite some time to get things straight and actually build and pass all checks.

I'll look through the rest in the beginning of January.

I may not have time in January to carry the burden of the next release.

martinmortsell

Looks mostly fine to me, could benefit from squashing some commits, aside from the one or two minor changes I suggested.

martinmortsell · 2024-01-03T07:46:16Z

CHANGELOG.md

 - Update `cortex-m-rt` version in examples to `0.7.3`.
 - Switched from AFE0_AD6 to  AFE0_AD8 for the atsamv71_xult board ADC example code.
+- The `rt` separated to don't act as part of chip selection feature anymore.


Change to

Suggested change

- The `rt` separated to don't act as part of chip selection feature anymore.

- The `rt` separated to not act as part of chip selection feature anymore.

martinmortsell · 2024-01-03T07:48:33Z

Cargo.toml

+# In the end it doesn't work as I supposed based on `Cargo.toml` from other
+# projects. First, it works only at workspace level; second, it's not optional
+# in the sense of probing for existence. We shall consider documenting use of
+# https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#paths-overrides
+# atsame70j19b = { path = "../atsamx7x-pac/pac/atsame70j19b" }
+# atsame70j20b = { path = "../atsamx7x-pac/pac/atsame70j20b" }
+# atsame70j21b = { path = "../atsamx7x-pac/pac/atsame70j21b" }
+# atsame70n19b = { path = "../atsamx7x-pac/pac/atsame70n19b" }
+# atsame70n20b = { path = "../atsamx7x-pac/pac/atsame70n20b" }
+# atsame70n21b = { path = "../atsamx7x-pac/pac/atsame70n21b" }
+# atsame70q19b = { path = "../atsamx7x-pac/pac/atsame70q19b" }
+# atsame70q20b = { path = "../atsamx7x-pac/pac/atsame70q20b" }
+# atsame70q21b = { path = "../atsamx7x-pac/pac/atsame70q21b" }
+# atsams70j19b = { path = "../atsamx7x-pac/pac/atsams70j19b" }
+# atsams70j20b = { path = "../atsamx7x-pac/pac/atsams70j20b" }
+# atsams70j21b = { path = "../atsamx7x-pac/pac/atsams70j21b" }
+# atsams70n19b = { path = "../atsamx7x-pac/pac/atsams70n19b" }
+# atsams70n20b = { path = "../atsamx7x-pac/pac/atsams70n20b" }
+# atsams70n21b = { path = "../atsamx7x-pac/pac/atsams70n21b" }
+# atsams70q19b = { path = "../atsamx7x-pac/pac/atsams70q19b" }
+# atsams70q20b = { path = "../atsamx7x-pac/pac/atsams70q20b" }
+# atsams70q21b = { path = "../atsamx7x-pac/pac/atsams70q21b" }
+# atsamv70j19b = { path = "../atsamx7x-pac/pac/atsamv70j19b" }
+# atsamv70j20b = { path = "../atsamx7x-pac/pac/atsamv70j20b" }
+# atsamv70n19b = { path = "../atsamx7x-pac/pac/atsamv70n19b" }
+# atsamv70n20b = { path = "../atsamx7x-pac/pac/atsamv70n20b" }
+# atsamv70q19b = { path = "../atsamx7x-pac/pac/atsamv70q19b" }
+# atsamv70q20b = { path = "../atsamx7x-pac/pac/atsamv70q20b" }
+# atsamv71j19b = { path = "../atsamx7x-pac/pac/atsamv71j19b" }
+# atsamv71j20b = { path = "../atsamx7x-pac/pac/atsamv71j20b" }
+# atsamv71j21b = { path = "../atsamx7x-pac/pac/atsamv71j21b" }
+# atsamv71n19b = { path = "../atsamx7x-pac/pac/atsamv71n19b" }
+# atsamv71n20b = { path = "../atsamx7x-pac/pac/atsamv71n20b" }
+# atsamv71n21b = { path = "../atsamx7x-pac/pac/atsamv71n21b" }
+# atsamv71q19b = { path = "../atsamx7x-pac/pac/atsamv71q19b" }
+# atsamv71q20b = { path = "../atsamx7x-pac/pac/atsamv71q20b" }
+# atsamv71q21b = { path = "../atsamx7x-pac/pac/atsamv71q21b" }


Unclear to me what the purpose of these lines are, but if you don't have a plan for fixing it, these lines should be removed rather than commented out.

martinmortsell · 2024-01-03T07:49:57Z

hal/Cargo.toml

-can = ["mcan-core"]
-
-device-selected = []
+__v71 = ["can"]


underscores for internal features, nice.

michalfita added 3 commits December 23, 2023 11:38

[Fixes #72] Foundation: rearrange nested features

533b0eb

Since Rust 1.60 it's possible to enable dependencies' features only for included dependencies. That's going to work for `rt` and `critical-section` and some other features in future.

[Fixes #72] Fix formatting of build.rs

dbfa277

[Fixes #72] Things don't play in our favour

f6739f5

michalfita added bug Something isn't working enhancement New feature or request build system Related to build system or CI support dependencies Pull requests that update a dependency file labels Dec 23, 2023

michalfita added this to the HAL Release 0.5.0 milestone Dec 23, 2023

michalfita added 3 commits December 23, 2023 13:25

[Fixes #72] Fix examples to work with new alpha release

56ee0f9

[Fixes #72] All examples back to take()

6552571

``` let pac = hal::pac::Peripherals::take().unwrap(); ``` instead of ``` let pac = hal::pac::Peripherals::take().unwrap(); ```

[Fixes #72] Make critical-section optional for HAL crate

a631cc0

michalfita requested a review from martinmortsell December 23, 2023 14:19

michalfita added 6 commits December 23, 2023 14:26

[Fixes #72] Fix second example missed first time

af31fbe

[Fixes #72] Scope creep: fix bumped-up USB support (HAL & example)

fb4c01e

[Fixes #72] Remove rogue whitespace

ad7af38

[Fixes #72] Fix formatting of amended fragment in example

c809595

[Fixes #72] That's USB change hit me badly

96b8f9d

It would be nice to have a tool that extracts all basic check from workflow to be run before commit. Not working on machine I normally burn for this stuff has downsides, as I rush things...

[Fixes #72] USB require fix in doctests

8775dd0

michalfita marked this pull request as ready for review December 23, 2023 18:04

martinmortsell suggested changes Jan 3, 2024

View reviewed changes

michalfita added 2 commits January 3, 2024 15:57

[Fixes #72] Cleaning-up

a2cfe05

[Fixes #72] Update CHANGELOG.md

0a4010d

michalfita merged commit d1664b1 into development Jan 3, 2024
88 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fixes #72] Deal with dependencies to fix things, mostly doctests #73

[Fixes #72] Deal with dependencies to fix things, mostly doctests #73

michalfita commented Dec 23, 2023

michalfita commented Dec 23, 2023

martinmortsell commented Dec 23, 2023

michalfita commented Dec 23, 2023

martinmortsell left a comment

martinmortsell Jan 3, 2024

martinmortsell Jan 3, 2024

martinmortsell Jan 3, 2024

	- The `rt` separated to don't act as part of chip selection feature anymore.
	- The `rt` separated to not act as part of chip selection feature anymore.

[Fixes #72] Deal with dependencies to fix things, mostly doctests #73

[Fixes #72] Deal with dependencies to fix things, mostly doctests #73

Conversation

michalfita commented Dec 23, 2023

Purpose

Scope

michalfita commented Dec 23, 2023

martinmortsell commented Dec 23, 2023

michalfita commented Dec 23, 2023

martinmortsell left a comment

Choose a reason for hiding this comment

martinmortsell Jan 3, 2024

Choose a reason for hiding this comment

martinmortsell Jan 3, 2024

Choose a reason for hiding this comment

martinmortsell Jan 3, 2024

Choose a reason for hiding this comment