Merge #394

394: Split nb and can traits to separate crates. r=eldruin a=Dirbaio

Following up from #177 (comment), this PR splits `nb` and `can` traits to separate crates.

I propose keeping these crates (and `embedded-hal-async`) separate forever. (instead of merging EHA into EH when stable as we originally planned when we created EHA).

Reasons for splitting `nb`:
- its future is unclear. Some people who would like to see `nb` deprecated. By splitting, if we do deprecate it, we won't get stuck with it in the main `embedded-hal` crate forever.
- It makes the module paths in the main crate cleaner.
- Traits tied to a particular "execution model" in their own crates, which make the overall structure easier to understand IMO.

Reasons for splitting `can`:
- It has some open concerns: #381 #387 
- Even if we do solve these, it's nice to have separate crates for the "more specialized" traits so that they can be major-bumped in the future if more concerns arise, without having to major-bump the main `embedded-hal` crate.

TODO:

- [x] Name it `embedded-can`, not `embedded-hal-can`.
- [x] Move/remove docs/examples from the main crate that mention `nb`.
- [x] Mention the subcrates from the main crate's docs.
- [x] Add CI
- [x] move `embedded-hal` to a subdir as well
- [x] What should the nb, can crate versions be? 1.0? (no opinion on this from me).
   - [x] can: 0.4
   - [x] nb: 1.0

Co-authored-by: Dario Nieuwenhuis <[email protected]>
Co-authored-by: Diego Barrios Romero <[email protected]>

Author: 3 people

.github/bors.toml

@@ -2,11 +2,14 @@ block_labels = ["needs-decision"]
 delete_merged_branches = true
 required_approvals = 1
 status = [
-  "ci-linux (stable, x86_64-unknown-linux-gnu)",
-  "ci-linux (stable, thumbv6m-none-eabi)",
-  "ci-linux (stable, thumbv7m-none-eabi)",
-  "ci-linux (1.54.0, x86_64-unknown-linux-gnu)",
-  "ci-linux-test (stable)",
-  "ci-linux-test (1.54.0, x86_64-unknown-linux-gnu)",
+  "test (stable, x86_64-unknown-linux-gnu)",
+  "test (stable, thumbv6m-none-eabi)",
+  "test (stable, thumbv7m-none-eabi)",
+  "test (1.54.0, x86_64-unknown-linux-gnu)",
+  "test (1.54.0, thumbv6m-none-eabi)",
+  "test (1.54.0, thumbv7m-none-eabi)",
+  "test (nightly, x86_64-unknown-linux-gnu)",
+  "test (nightly, thumbv6m-none-eabi)",
+  "test (nightly, thumbv7m-none-eabi)",
   "fmt",
 ]

.github/workflows/changelog.yml

@@ -5,14 +5,16 @@ on:
 
 name: Clippy check
 jobs:
-  clippy_check:
+  clippy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
-          toolchain: stable
+          # embedded-hal-async needs nightly.
+          # Use a pinned version to avoid spontaneous breakages (new clippy lints are added often)
+          toolchain: nightly-2022-09-05  
           override: true
           components: clippy
       - uses: actions-rs/clippy-check@v1

.github/workflows/ci-async.yml

@@ -16,9 +16,4 @@ jobs:
           toolchain: nightly
           override: true
           components: rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
-      - run: cargo fmt --all -- --check
-        working-directory: embedded-hal-async
+      - run: cargo fmt --check

.github/workflows/ci-bus.yml

@@ -3,35 +3,41 @@ on:
     branches: [ staging, trying, master ]
   pull_request:
 
-name: Test Suite
+name: Continuous integration
 
 env:
   RUSTFLAGS: '--deny warnings'
 
 jobs:
-  ci-linux-test:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rust: [stable]
+        # All generated code should be running on stable now
+        rust:
+          - stable
+          - 1.54.0  # MSRV
+          - nightly
 
-        include:
-          - rust: 1.54.0
-            TARGET: x86_64-unknown-linux-gnu
-
-          # Test nightly but don't fail
-          - rust: nightly
-            experimental: true
-            TARGET: x86_64-unknown-linux-gnu
+        # The default target we're compiling on and for
+        target:
+          - x86_64-unknown-linux-gnu
+          - thumbv6m-none-eabi
+          - thumbv7m-none-eabi
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: ${{ matrix.rust }}
-          target: ${{ matrix.TARGET }}
+          target: ${{ matrix.target }}
           override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: test
+
+      - run: sed -i '/nightly-only/d' Cargo.toml 
+        if: matrix.toolchain != 'nightly'
+
+      - run: cargo check --target=${{ matrix.target }}
+
+      - run: cargo test --target=${{ matrix.target }}
+        if: contains(matrix.target, 'linux')